Ice Docs

IceDiscovery.*

6 min read

6 min read

6 min read

6 min read

6 min read

6 min read

6 min read

6 min read

6 min read

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

These properties configure the C++, C# and Java plug-ins, and the C++ plug-in loaded through Ice.Plugin.* in the C++-based language mappings. JavaScript does not support this plug-in.

IceDiscovery.Address=addr

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

This property is used to compose the value of IceDiscovery.Lookup and IceDiscovery.Multicast.Endpoints.

IceDiscovery.DomainId=id

Specifies the domain ID used to locate objects and object adapters. The IceDiscovery plug-in only responds to requests from clients with the same domain ID and ignores requests from clients with a different domain ID. If not defined, the default domain ID is an empty string.

IceDiscovery.Interface=intf

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

IceDiscovery.Lookup=endpoints

Specifies the multicast endpoints used to send discovery queries. The plug-in sends each query on every endpoint in this list.

When this property is not set, the plug-in creates one endpoint per multicast-capable interface selected by IceDiscovery.Interface, or per available multicast-capable interface if that property is not set. It joins these endpoints with colons. Each endpoint has the form:

udp -h "addr" -p port --interface "intf"

Here, addr is the value of IceDiscovery.Address, port is the value of IceDiscovery.Port, and intf identifies the interface.

IceDiscovery.Multicast.AdapterProperty=value

IceDiscovery creates an object adapter named IceDiscovery.Multicast for receiving discovery queries from clients. If not otherwise defined by IceDiscovery.Multicast.Endpoints, the endpoint for this object adapter is composed as follows:

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

where addr is the value of IceDiscovery.Address, port is the value of IceDiscovery.Port, and intf is the value of IceDiscovery.Interface.

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

IceDiscovery.LatencyMultiplier=num

Specifies the multiplier to apply to the latency of the first discovery request-reply for replica groups. When IceDiscovery receives a reply for a discovery request and this reply indicates that the adapter identifier is a replica group, it waits for an additional time interval for other responses from replicated servers. This time interval is based on the latency of the first request-reply and the latency multiplier. For example, if the first reply is received after 15 milliseconds and the multiplier is set to 4, IceDiscovery will wait for an additional 60 milliseconds for replies from other servers. If not defined, the default is 1. num must be 1 or greater.

IceDiscovery.Port=port

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

IceDiscovery.Reply.AdapterProperty=value

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

udp -h "intf"

Here, intf is IceDiscovery.Interface. When that property is unset, the plug-in uses udp -h * to bind to all local interfaces. The object adapter properties configure the other settings of this adapter.

IceDiscovery.RetryCount=num

Specifies the maximum number of times that the plug-in will retry sending UDP multicast requests before giving up. The IceDiscovery.Timeout property determines how long the plug-in waits for a reply before trying again. If not defined, the default retry count is 3, for a total of four attempts. A value of 0 sends only the initial query.

IceDiscovery.Timeout=num

Specifies the time interval in milliseconds to wait for replies to UDP multicast requests. If no server replies during this time interval, the client will retry the request the number of times specified by IceDiscovery.RetryCount. If not defined, the default timeout is 300. num must be greater than 0.