D.2 Endpoints

Synopsis

endpoint : endpoint

Description

An endpoint list comprises one or more endpoints separated by a colon (:). An endpoint has the following format:

protocol option

The supported protocols are tcp, udp, ssl, and default. If default is used, it is replaced by the value of the Ice.Default.Protocol property. If an endpoint is malformed, or an unknown protocol is specified, the application receives Ice::EndpointParseException.

The ssl protocol is only available if the IceSSL plug‑in is installed.

The protocols and their supported options are described in the sections that follow.

TCP Endpoint

Synopsis

tcp ‑h host ‑p port ‑t timeout ‑z

Description

A tcp endpoint supports the following options:

Option	Description	Client Semantics	Server Semantics
‑h host	Specifies the host name or IP address of the endpoint. If not specified, the value of Ice.Default.Host is used instead.	Determines the host name or IP address to which a connec­tion attempt is made. If not specified, the looback interface is used.	Determines the net­work interface on which the object adapter listens for connections. If not specified, (or speci­fied as ‑h * or ‑h 0.0.0.0), the adapter listens on all network interfaces (including the loop­back interface). The endpoints specified by ‑h are published in proxies. If not specified, all end­points except loop­back are published (except if loopback is the only available interface, in which case only loopback is published).
‑p port	Specifies the port number of the end­point.	Determines the port to which a connec­tion attempt is made (required).	The port will be selected by the oper­ating system if this option is not speci­fied or port is zero.
‑t tim­eout	Specifies the end­point timeout in mil­liseconds.	If timeout is greater than zero, it sets a maximum delay for binding and proxy invocations. If a tim­eout occurs, the application receives Ice::TimeoutException.	Determines the default timeout that is advertised in prox­ies created by the object adapter.
‑z	Specifies bzip2 com­pression.	Determines whether compressed requests are sent.	Determines whether compression is advertised in prox­ies created by the adapter.

UDP Endpoint

Synopsis

udp ‑v major.minor ‑e major.minor ‑h host ‑p port ‑z

Description

A udp endpoint supports the following options:

Option	Description	Client Semantics	Server Semantics
‑v major.minor	Specifies the protocol major and highest minor version num­ber to be used for this endpoint. If not spec­ified, the protocol major version and highest supported minor version of the client-side Ice run time is used.	Determines the pro­tocol major version and highest minor version used by the client side when sending messages to this endpoint. The protocol major ver­sion number must match the protocol major version num­ber of the server; the protocol minor ver­sion number must not be higher than the highest minor version number supported by the server.	Determines the pro­tocol major version and highest minor version advertised by the server side for this endpoint. The protocol major ver­sion number must match the protocol major version num­ber of the server; the protocol minor ver­sion number must not be higher than the highest minor version number supported by the server.
‑e major.minor	Specifies the encod­ing major and highest minor version num­ber to be used for this endpoint. If not spec­ified, the encoding major version and highest supported minor version of the client-side Ice run time is used.	Determines the encoding major ver­sion and highest minor version used by the client side when sending mes­sages to this end­point. The encoding major version num­ber must match the encoding major ver­sion number of the server; the encoding minor version num­ber must not be higher than the high­est minor version number supported by the server.	Determines the encoding version and highest minor version advertised by the server side for this endpoint. The proto­col major version number must match the protocol major version number of the server; the proto­col minor version number must not be higher than the high­est minor version number supported by the server.
‑h host	Specifies the host name or IP address of the endpoint. If not specified, the value of Ice.Default.Host is used instead.	Determines the host name or IP address to which a connection attempt is made. If not specified, the loo­back interface is used.	Determines the net­work interface on which the object adapter listens for datagrams. If not specified, (or speci­fied as ‑h * or ‑h 0.0.0.0), the adapter listens on all network interfaces (including the loop­back interface). The endpoints specified by ‑h are published in proxies. If not specified, all end­points except loop­back are published (except if loopback is the only available interface, in which case only loopback is published).
‑p port	Specifies the port number of the end­point.	Determines the port to which datagrams are sent (required).	The port will be selected by the oper­ating system if this option is not speci­fied or port is zero.
‑z	Specifies bzip2 com­pression.	Determines whether compressed requests are sent.	Determines whether compression is advertised in proxies created by the adapter.

SSL Endpoint

Synopsis

ssl ‑h host ‑p port ‑t timeout ‑z

Description

An ssl endpoint supports the following options:

Option	Description	Client Semantics	Server Semantics
‑h host	Specifies the host name or IP address of the endpoint. If not specified, the value of Ice.Default.Host is used instead.	Determines the host name or IP address to which a connec­tion attempt is made. If not specified, the looback interface is used.	Determines the net­work interface on which the object adapter listens for connections. If not specified, (or speci­fied as ‑h * or ‑h 0.0.0.0), the adapter listens on all network interfaces (including the loop­back interface). The endpoints specified by ‑h are published in proxies. If not specified, all end­points except loop­back are published (except if loopback is the only available interface, in which case only loopback is published).
‑p port	Specifies the port number of the end­point.	Determines the port to which a connec­tion attempt is made (required).	The port will be selected by the oper­ating system if this option is not speci­fied or port is zero.
‑t tim­eout	Specifies the end­point timeout in mil­liseconds.	If timeout is greater than zero, it sets a maximum delay for binding and proxy invocations. If a tim­eout occurs, the application receives Ice::TimeoutException.	Determines the default timeout that is advertised in prox­ies created by the object adapter.
‑z	Specifies bzip2 com­pression.	Determines whether compressed requests are sent.	Determines whether compression is advertised in proxies created by the adapter.