IceLocatorDiscovery.*

This page describes the properties supported by the IceLocatorDiscovery plug-in.

On this page:

IceLocatorDiscovery.Address

Synopsis

IceLocatorDiscovery.Address=addr

Description

Specifies the multicast IP address to use for sending multicast discovery queries. If not defined, the default value depends on other property settings:

  • If Ice.PreferIPv6Address is enabled or Ice.IPv4 is disabled, IceLocatorDiscovery uses the IPv6 address ff15::1
  • Otherwise IceLocatorDiscovery uses 239.255.0.1

This property is used to compose the value of IceLocatorDiscovery.Lookup.

IceLocatorDiscovery.InstanceName

Synopsis

IceLocatorDiscovery.InstanceName=name

Description

Specifies the name of a locator instance. If you have multiple unrelated locators deployed that use the same multicast address and port, you can define this property to limit your discovery results only to those locators deployed for the given instance. If not defined, the plug-in adopts the instance name of the first locator to respond to a query; if a subsequent query discovers a locator with a different instance name, the plug-in logs a message and ignores the result.

IceLocatorDiscovery.Interface

Synopsis

IceLocatorDiscovery.Interface=intf

Description

Specifies the IP address of the interface to use for sending multicast discovery queries. If not defined, the discovery will use all the network interfaces available on the system to send UDP multicast datagrams. This property is used to compose the value of IceLocatorDiscovery.Lookup and IceLocatorDiscovery.Reply.Endpoints.

IceLocatorDiscovery.Locator.AdapterProperty

Synopsis

IceLocatorDiscovery.Locator.AdapterProperty=value

Description

IceLocatorDiscovery creates an object adapter named IceLocatorDiscovery.Locator, therefore all of the object adapter properties can be set.

You don't normally need to set properties for this object adapter.

IceLocatorDiscovery.Lookup

Synopsis

IceLocatorDiscovery.Lookup=endpoints

Description

Specifies the multicast endpoints that a client uses to send multicast discovery queries. If not defined, the endpoint is composed as follows:

udp -h addr -p port [--interface intf]

where addr is the value of IceLocatorDiscovery.Addressport is the value of IceLocatorDiscovery.Port, and intf is the value of IceLocatorDiscovery.Interface. If multiple endpoints are defined, the  queries will be sent on each endpoint.

IceLocatorDiscovery.Port

Synopsis

IceLocatorDiscovery.Port=port

Description

Specifies the multicast port to use for sending multicast queries. If not set, the default value is 4061.

IceLocatorDiscovery.Reply.AdapterProperty

Synopsis

IceLocatorDiscovery.Reply.AdapterProperty=value

Description

IceLocatorDiscovery creates an object adapter named IceLocatorDiscovery.Reply for receiving replies to multicast discovery queries. If not otherwise defined by IceLocatorDiscovery.Reply.Endpoints, the endpoint for this object adapter is composed as follows:

udp [-h intf]

where intf is the value of IceLocatorDiscovery.Interface. A fixed port is not necessary for this endpoint.

You don't normally need to set other properties for this object adapter.

IceLocatorDiscovery.RetryCount

Synopsis

IceLocatorDiscovery.RetryCount=num

Description

Specifies the maximum number of times that the plug-in will retry sending UDP multicast queries before giving up. The IceLocatorDiscovery.Timeout property determines how long the plug-in waits for a reply before trying again. If not defined, the default retry count is 3.

IceLocatorDiscovery.RetryDelay

Synopsis

IceLocatorDiscovery.RetryDelay=num

Description

If the plug-in fails to receive any responses to a query after retrying the number of times specified by IceLocatorDiscovery.RetryCount, the plug-in waits at least num milliseconds before starting another round of query attempts. If not defined, the default value is 2000.

IceLocatorDiscovery.Trace.Lookup

Synopsis

IceLocatorDiscovery.Trace.Lookup=num

Description

The lookup trace level:

0

No lookup trace (default).

1

Trace lookup success, failure or time out.

2Like 1, but more verbose, also trace the lookup invocations.

IceLocatorDiscovery.Timeout

Synopsis

IceLocatorDiscovery.Timeout=num

Description

Specifies the time interval in milliseconds to wait for replies to UDP multicast queries. If no server replies during this time interval, the client will retry the request the number of times specified by IceLocatorDiscovery.RetryCount. If not defined, the default timeout is 300.