Interface Client_ConstructProps

Hierarchy

Initable_ConstructProps
GObject.Object_ConstructProps
- Client_ConstructProps
  - GUPnP.Context_ConstructProps

Index

Properties

Optional active

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.

Optional hostIp

hostIp?: string

The IP address of the assoicated network interface.

Optional interface

interface?: string

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

Optional msearchPort

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.

Optional network

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.

Optional serverId

serverId?: string

The SSDP server's identifier.

Optional socketTtl

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.