Gjsify LogoGjsify Logo

Hierarchy

Index

Constructors

Properties

acl: GUPnP.Acl

An access control list.

active: boolean

Whether this client is active or not (passive). When active (default), the client sends messages on the network, otherwise not. In most cases, you don't want to touch this property.

addressFamily: SocketFamily

The IP protocol address family this client works on. When specified during construction without giving a concrete address, it will be used to determine the proper address.

If not specified, will contain the currrent address family after the call to g_initable_init(). Use %G_SOCKET_FAMILY_INVALID to specifiy using the default socket family (legacy IP)

bootId: number

The value of the BOOTID.UPNP.ORG header

Since 1.2.0

configId: number

The value of the CONFIGID.UPNP.ORG header

Since 1.2.0

defaultLanguage: string

The content of the Content-Language header id the client sends Accept-Language and no language-specific pages to serve exist. The property defaults to 'en'.

gTypeInstance: TypeInstance
hostIp: string

The IP address of the assoicated network interface.

hostMask: InetAddressMask

The network mask of the assoicated network interface.

interface: string

The name of the network interface this client is associated with. Set to NULL to autodetect.

msearchPort: number

UDP port to use for sending multicast M-SEARCH requests on the network. If not set (or set to 0) a random port will be used. This property can be only set during object construction.

network: string

The network this client is currently connected to. You could set this to anything you want to identify the network this client is associated with. If you are using #GUPnPContextManager and associated interface is a WiFi interface, this property is set to the ESSID of the network. Otherwise, expect this to be the network IP address by default.

parentInstance: GSSDP.Client
port: number

The port to run on. Set to 0 if you don't care what port to run on.

server: Soup.Server

The #SoupServer HTTP server used by GUPnP.

serverId: string

The SSDP server's identifier.

session: Soup.Session

The #SoupSession object used by GUPnP.

socketTtl: number

Time-to-live value to use for all sockets created by this client. If not set (or set to 0) the value recommended by UPnP will be used. This property can only be set during object construction.

subscriptionTimeout: number

The preferred subscription timeout: the number of seconds after which subscriptions are renewed. Set to '0' if subscriptions are never to time out.

udaVersion: UDAVersion

The UPnP version the client adheres to.

name: string

Methods

  • addCacheEntry(ipAddress: string, userAgent: string): void
  • Add user_agent for ip_address.

    Each [classGSSDP.Client] maintains a mapping of addresses (MAC on systems that support it, IP addresses otherwise) to User Agents.

    This information can be used in higher layers to get an User-Agent for devices that do not set the User-Agent header in their SOAP requests.

    Parameters

    • ipAddress: string

      The host to add to the cache

    • userAgent: string

      User agent ot the host to add

    Returns void

  • Add a #SoupServerCallback to the #GUPnPContext's #SoupServer.

    Parameters

    • useAcl: boolean

      %TRUE, if the path should query the GUPnPContext::acl before serving the resource, %FALSE otherwise.

    • path: string

      the toplevel path for the handler.

    • callback: Soup.ServerCallback

      callback to invoke for requests under path

    Returns void

  • appendHeader(name: string, value: string): void
  • Adds a header field to the messages sent by this client. It is intended to be used by clients requiring vendor specific header fields.

    If there is an existing header with name it will append another one.

    Parameters

    • name: string

      Header name

    • value: string

      Header value

    Returns void

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned #GBinding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A #GObject can have multiple bindings.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transformFrom: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • Check if the peer at address is reachable using this client.

    Parameters

    • address: InetSocketAddress

      A #GInetSocketAddress of the target. The port part of the address may be 0

    Returns boolean

  • clearHeaders(): void
  • connect(sigName: "notify::acl", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::default-language", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::port", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::server", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::session", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::subscription-timeout", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::active", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::address-family", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::boot-id", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::config-id", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::host-ip", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::host-mask", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::interface", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::msearch-port", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::network", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::server-id", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::socket-ttl", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::uda-version", callback: ((...args: any[]) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • Parameters

    • sigName: "notify::acl"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::default-language"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::port"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::server"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::session"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::subscription-timeout"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::active"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::address-family"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::boot-id"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::config-id"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::host-ip"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::host-mask"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::interface"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::msearch-port"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::network"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::server-id"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::socket-ttl"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::uda-version"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • emit(sigName: "notify::acl", ...args: any[]): void
  • emit(sigName: "notify::default-language", ...args: any[]): void
  • emit(sigName: "notify::port", ...args: any[]): void
  • emit(sigName: "notify::server", ...args: any[]): void
  • emit(sigName: "notify::session", ...args: any[]): void
  • emit(sigName: "notify::subscription-timeout", ...args: any[]): void
  • emit(sigName: "notify::active", ...args: any[]): void
  • emit(sigName: "notify::address-family", ...args: any[]): void
  • emit(sigName: "notify::boot-id", ...args: any[]): void
  • emit(sigName: "notify::config-id", ...args: any[]): void
  • emit(sigName: "notify::host-ip", ...args: any[]): void
  • emit(sigName: "notify::host-mask", ...args: any[]): void
  • emit(sigName: "notify::interface", ...args: any[]): void
  • emit(sigName: "notify::msearch-port", ...args: any[]): void
  • emit(sigName: "notify::network", ...args: any[]): void
  • emit(sigName: "notify::server-id", ...args: any[]): void
  • emit(sigName: "notify::socket-ttl", ...args: any[]): void
  • emit(sigName: "notify::uda-version", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • forceFloating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • freezeNotify(): void
  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • Access the #GUPnPAcl associated with this client. If there isn't any, retturns %NULL. The returned ACL must not be freed.

    Returns GUPnP.Acl

  • getActive(): boolean
  • getData(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • getDefaultLanguage(): string
  • Get the default Content-Language header for this context.

    Returns string

  • getHostIp(): string
  • getIndex(): number
  • getInterface(): string
  • getNetwork(): string
  • getPort(): number
  • Get the port that the SOAP server is running on.

    Returns number

  • getProperty(propertyName?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional propertyName: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • getQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • getServerId(): string
  • getSubscriptionTimeout(): number
  • Get the event subscription timeout (in seconds), or 0 meaning there is no timeout.

    Returns number

  • getv(names: string[], values: any[]): void
  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • guessUserAgent(ipAddress: string): string
  • hostPath(localPath: string, serverPath: string): void
  • Start hosting local_path at server_path. Files with the path local_path.LOCALE (if they exist) will be served up when LOCALE is specified in the request's Accept-Language header.

    Parameters

    • localPath: string

      Path to the local file or folder to be hosted

    • serverPath: string

      Web server path where local_path should be hosted

    Returns void

  • hostPathForAgent(localPath: string, serverPath: string, userAgent: GLib.Regex): boolean
  • Use this method to serve different local path to specific user-agent(s). The path server_path must already be hosted by context.

    Parameters

    • localPath: string

      Path to the local file or folder to be hosted

    • serverPath: string

      Web server path already being hosted

    • userAgent: GLib.Regex

      The user-agent as a #GRegex.

    Returns boolean

  • Initializes the object implementing the interface.

    This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead.

    The object must be initialized before any real use after initial construction, either with this function or g_async_initable_init_async().

    Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL and the object doesn't support cancellable initialization the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

    If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. See the [introduction][ginitable] for more details.

    Callers should not assume that a class which implements #GInitable can be initialized multiple times, unless the class explicitly documents itself as supporting this. Generally, a class’ implementation of init() can assume (and assert) that it will only be called once. Previously, this documentation recommended all #GInitable implementations should be idempotent; that recommendation was relaxed in GLib 2.54.

    If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.

    One reason why a class might need to support idempotent initialization is if it is designed to be used via the singleton pattern, with a #GObjectClass.constructor that sometimes returns an existing instance. In this pattern, a caller would expect to be able to call g_initable_init() on the result of g_object_new(), regardless of whether it is in fact a new instance.

    Parameters

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    Returns boolean

  • isFloating(): boolean
  • notify(propertyName: string): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • propertyName: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • off(sigName: "notify::acl", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::default-language", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::port", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::server", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::session", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::subscription-timeout", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::active", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::address-family", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::boot-id", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::config-id", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::host-ip", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::host-mask", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::interface", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::msearch-port", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::network", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::server-id", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::socket-ttl", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::uda-version", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • Parameters

    • sigName: "notify::acl"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::default-language"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::port"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::server"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::session"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::subscription-timeout"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::active"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::address-family"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::boot-id"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::config-id"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::host-ip"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::host-mask"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::interface"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::msearch-port"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::network"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::server-id"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::socket-ttl"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::uda-version"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • on(sigName: "notify::acl", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::default-language", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::port", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::server", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::session", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::subscription-timeout", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::active", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::address-family", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::boot-id", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::config-id", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::host-ip", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::host-mask", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::interface", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::msearch-port", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::network", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::server-id", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::socket-ttl", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::uda-version", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    • sigName: "notify::acl"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::default-language"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::port"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::server"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::session"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::subscription-timeout"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::active"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::address-family"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::boot-id"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::config-id"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::host-ip"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::host-mask"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::interface"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::msearch-port"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::network"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::server-id"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::socket-ttl"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::uda-version"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • once(sigName: "notify::acl", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::default-language", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::port", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::server", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::session", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::subscription-timeout", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::active", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::address-family", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::boot-id", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::config-id", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::host-ip", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::host-mask", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::interface", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::msearch-port", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::network", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::server-id", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::socket-ttl", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::uda-version", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    • sigName: "notify::acl"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::default-language"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::port"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::server"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::session"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::subscription-timeout"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::active"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::address-family"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::boot-id"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::config-id"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::host-ip"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::host-mask"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::interface"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::msearch-port"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::network"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::server-id"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::socket-ttl"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::uda-version"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

  • removeHeader(name: string): void
  • Removes name from the list of headers. If there are multiple values for name, they are all removed.

    Parameters

    • name: string

      Header name

    Returns void

  • removeServerHandler(path: string): void
  • Remove a #SoupServerCallback from the #GUPnPContext's #SoupServer.

    Parameters

    • path: string

      the toplevel path for the handler.

    Returns void

  • rewriteUri(uri: string): string
  • Utility function to re-write an uri to the IPv6 link-local form which has the zone index appended to the IP address.

    Parameters

    • uri: string

      an uri to rewrite if necessary

    Returns string

  • runDispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • Attach or remove the assoicated access control list to this context. If acl is %NULL, the current access control list will be removed.

    Parameters

    • acl: GUPnP.Acl

      The new access control list or %NULL to remove the current list.

    Returns void

  • setBootId(bootId: number): void
  • Will set the new boot-id for this SSDP client. Does nothing if the UDA version used by the client is UDA 1.0

    The boot-id is used to signalize changes in the network configuration for multi-homed hosts

    Parameters

    • bootId: number

      The new boot-id for the client

    Returns void

  • setConfigId(configId: number): void
  • The config-id is used to allow caching of the device or service description. It should be changed if that changes.

    Parameters

    • configId: number

      The new config-id for the client

    Returns void

  • setData(key: string, data?: object): void
  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a #GQuark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • setDefaultLanguage(language: string): void
  • Set the default language for the Content-Language header to language.

    If the client sends an Accept-Language header the UPnP HTTP server is required to send a Content-Language header in return. If there are no files hosted in languages which match the requested ones the Content-Language header is set to this value. The default value is "en".

    Parameters

    • language: string

      A language tag as defined in RFC 2616 3.10

    Returns void

  • setNetwork(network: string): void
  • Sets the network identification of client to network.

    Parameters

    • network: string

      The string identifying the network

    Returns void

  • setProperty(propertyName: string, value?: any): void
  • Sets a property on an object.

    Parameters

    • propertyName: string

      the name of the property to set

    • Optional value: any

      the value

    Returns void

  • setServerId(serverId: string): void
  • Sets the server ID of client to server_id. This string is used as the "Server:" identification header for SSDP discovery and response packets and "User-Agent" header for searches.

    By default, GSSDP will generate a header conforming to the requirements defined in the UDA documents: OS/Version UPnP/Version GSSDP/Version.

    Parameters

    • serverId: string

      The server ID

    Returns void

  • setSubscriptionTimeout(timeout: number): void
  • Sets the event subscription timeout to timeout. Use 0 if you don't want subscriptions to time out. Note that any client side subscriptions will automatically be renewed.

    Parameters

    • timeout: number

      Event subscription timeout in seconds

    Returns void

  • stealData(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • stealQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • thawNotify(): void
  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • unhostPath(serverPath: string): void
  • Stop hosting the file or folder at server_path.

    Parameters

    • serverPath: string

      Web server path where the file or folder is hosted

    Returns void

  • unref(): void
  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.

    Returns void

  • watchClosure(closure: TClosure<any, any>): void
  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compatControl(what: number, data: object): number
  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • propertyName: string

      name of a property to look up.

    Returns ParamSpec

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of #GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Create a new #GUPnPContext with the specified main_context, iface and port.

    Using this utility function, the created client will be using UDA 1.0 and IPv4 only.

    Parameters

    • iface: string

      The network interface to use, or %NULL to auto-detect.

    • port: number

      Port to run on, or 0 if you don't care what port is used.

    Returns GUPnP.Context

  • Creates a GSSDP client on iface. GSSDPClient will pick the address it finds suitable for using.

    Using this utility function, the created client will be using UDA 1.0 and IPv4 only.

    Parameters

    • iface: string

      The name of the network interface, or %NULL for auto-detection.

    Returns GSSDP.Client

  • newWithPort(iface: string, msearchPort: number): GSSDP.Client
  • Creates a GSSDP client on iface. GSSDPClient will pick the address it finds suitable for using.

    Using this utility function, the created client will be using UDA 1.0 and IPv4 only.

    Parameters

    • iface: string

      The name of the network interface, or %NULL for auto-detection.

    • msearchPort: number

      The network port to use for M-SEARCH requests or 0 for random.

    Returns GSSDP.Client

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • objectType: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method