Interface

GUPnP-1.6 ▶ GUPnP ▶ Acl ▶ Interface

Interface for implementing Acl. Contains only the virtual methods that need to be implemented.

interface Interface {
    vfunc_can_sync(): boolean;
    vfunc_is_allowed(
        device: GUPnP.Device,
        service: GUPnP.Service,
        path: string,
        address: string,
        agent?: string,
    ): boolean;
    vfunc_is_allowed_async(
        device: GUPnP.Device,
        service: GUPnP.Service,
        path: string,
        address: string,
        agent?: string,
        cancellable?: Gio.Cancellable,
        callback?: AsyncReadyCallback<GUPnP.Acl.Interface>,
    ): void;
    vfunc_is_allowed_finish(res: Gio.AsyncResult): boolean;
}

Hierarchy (View Summary)

Interface
- GUPnP.Acl

Index

Methods

vfunc_can_sync vfunc_is_allowed vfunc_is_allowed_async vfunc_is_allowed_finish

Methods

`Virtual`vfunc_can_sync

vfunc_can_sync(): boolean
Check whether GUPnP.Acl.is_allowed_async is supported.

Returns boolean
- Defined in gupnp-1.6/gupnp-1.6.d.ts:5511

`Virtual`vfunc_is_allowed

vfunc_is_allowed(
    device: GUPnP.Device,
    service: GUPnP.Service,
    path: string,
    address: string,
    agent?: string,
): boolean
Check whether an IP address is allowed to access this resource.
Parameters
- device: GUPnP.Device
  The GUPnP.Device associated with path or null if unknown.
- service: GUPnP.Service
  The GUPnP.Service associated with path or null if unknown.
- path: string
  The path being served.
- address: string
  IP address of the peer.
- Optionalagent: string
  The User-Agent header of the peer or null if unknown. returns true if the peer is allowed, false otherwise
Returns boolean
- Defined in gupnp-1.6/gupnp-1.6.d.ts:5521

`Virtual`vfunc_is_allowed_async

vfunc_is_allowed_async(
    device: GUPnP.Device,
    service: GUPnP.Service,
    path: string,
    address: string,
    agent?: string,
    cancellable?: Gio.Cancellable,
    callback?: AsyncReadyCallback<GUPnP.Acl.Interface>,
): void
Check asynchronously whether an IP address is allowed to access this resource.

This function is optional. GUPnP.Acl.can_sync should return true if the implementing class supports it. If it is supported, GUPnP will prefer to use this function over GUPnP.Acl.is_allowed.

Implement this function if the process of verifying the access right is expected to take some time, for example when using D-Bus etc.

Use GUPnP.Acl.is_allowed_finish to retrieve the result.
Parameters
- device: GUPnP.Device
  The GUPnP.Device associated with path or null if unknown.
- service: GUPnP.Service
  The GUPnP.Service associated with path or null if unknown.
- path: string
  The path being served.
- address: string
  IP address of the peer
- Optionalagent: string
  The User-Agent header of the peer or null if not unknown.
- Optionalcancellable: Gio.Cancellable
  A cancellable which can be used to cancel the operation.
- Optionalcallback: AsyncReadyCallback<GUPnP.Acl.Interface>
  Callback to call after the function is done.
Returns void
- Defined in gupnp-1.6/gupnp-1.6.d.ts:5549

`Virtual`vfunc_is_allowed_finish

vfunc_is_allowed_finish(res: Gio.AsyncResult): boolean
Get the result of GUPnP.Acl.is_allowed_async.
Parameters
- res: Gio.AsyncResult
  Gio.AsyncResult obtained from the callback passed to GUPnP.Acl.is_allowed_async
Returns boolean
- Defined in gupnp-1.6/gupnp-1.6.d.ts:5563