Previous Topic

Next Topic

Book Contents

Book Index

General Properties

Bellow you can find common system properties for the UPnP Module:

System Property

Type

Default Value

Description

mbs.upnp.startAfterFramework

boolean

false

A flag, which indicates if the UPnP Driver bundle should start after the System Bundle is activated.

mbs.upnp.multicast.port

int

1900

The port to listen for multicast discovery and search messages.

mbs.upnp.multicast.serverless.operation

boolean

false

If set to "true", the UPnP driver can operate even when no multicast socket can be created.

mbs.upnp.ipv4.only

boolean

true

A flag which makes the UPnP driver support only IPv4 as set by default. Set it to "false" to make the driver try to communicate on top of IPv6. However, if the JVM does not support IPv6, the driver will return to IPv4 mode.

mbs.upnp.no_IPv4

boolean

-

A flag, which indicates whether the control point and export manager should support (if "false") or not (if "true") IPv6 addresses compatible with IPv4. There is no default value set to this system property which is equivalent to setting "false" to it.

upnp.bind.address

String

-

The comma-separated list of the IP addresses to which the UPnP driver binds.

mbs.upnp.bind.interfaces

String

-

The comma-separated list of network interfaces on which the UPnP driver will execute network operations.

mbs.upnp.enable_site_local_operations

boolean

false

A flag, which indicates if the control point and the export manager will operate on IPv6 site-local scope (private site addressing). By default, it is disabled. Since current IPv6-enabled Java VMs do not handle link-local operations correctly, this property must be set to "false" to enable any IPv6 non-local discovery.

mbs.upnp.watchdog

boolean

false

A flag, that turns on/off the network watchdog.

mbs.upnp.watchdog.timeout

int

30000

The time period in milliseconds over which the watchdog checks the status of the device's network properties.

mbs.upnp.disable_multiple_device_ads

boolean

-

A flag to turn off/on multiple device advertisements from the OSGi device into the network. There is no default value set to this system property which is equivalent to setting "false" to it.

mbs.upnp.enable_localhost_operations

boolean

false

A flag to turn on/off processing all UPnP operations related to localhost as well.

mbs.upnp.disable_multiple_interfaces

boolean

false

If this property is "true", the multiple network interfaces are disabled and the UPnP driver operates only on the localhost IP address.

mbs.upnp.subscription.maxRetries

int

0

If the UPnP driver fails to subscribe to events about changes in the devices' state variables, it will retry the subscription until a success or a maximum number of attempts is reached.

mbs.upnp.server.socket.timeout

int

0

Sets the UPnP Driver server sockets timeout in milliseconds. By default, there is no timeout and the value of this property is "0".

mbs.upnp.socket.timeout

int

5000

Sets the UPnP Driver client sockets timeout in milliseconds.

mbs.upnp.stop.timeout

int

20000

When the UPnP Driver bundle is stopped it will wait no more than the time specified in milliseconds for all active operations to finish.

mbs.upnp.TTL

int

-1

Sets the time-to-live for multicast packets. By default, there is no time-to-live of the multicast packets and the value of this property is "-1".

mbs.upnp.sendByebyeBeforeFirstAlive

boolean

false

If set to "true" it sends a byebye message before the first device introduction.

mbs.upnp.cp.skipFakeDeviceUpdates

boolean

false

If set to "true" the device service is not updated if there are no changes.

mbs.upnp.http.maxDrainBytes

int

65536

Sets the maximum number of bytes to drain from the HTTP input stream buffer before the session is closed. Default value is 65536 bytes (64 KB).

mbs.upnp.action.argument.valueTrue

int

1

Sets the "true" value for the action argument ("true", "yes", etc.).

mbs.upnp.action.argument.valueFalse

int

0

Sets the "false" value for the action argument ("false", "no", etc.).

mbs.upnp.http.client.getoperationtimeout

int

15

Specifies the timeout for HTTP get operations, in seconds.

mbs.upnp.cp.ignore_ssdpalive_for

int

18

When the device is announced, the next announcements are skipped for this interval, in seconds.

mbs.upnp.cp.invalid_location_header_for

int

60000

If the device description is not accessible, further read requests will be ignored for this period, in milliseconds.