Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Proxy options configure the invocation mode:

-f facet

Select a facet of the Ice object.

-t

Configures the proxy for twoway invocations (default).

-o

Configures the proxy for oneway invocations.

-O

Configures the proxy for batch oneway invocations.

-d

Configures the proxy for datagram invocations.

-D

Configures the proxy for batch datagram invocations.

-s

Configures the proxy for secure invocations.

The proxy options -t, -o, -O, -d, and -D are mutually exclusive.

...

The presence (or absence) of the host parameter has a significant influence on the behavior of the Ice run time. The table below describes these semantics:

Value

Client Semantics

Server Semantics

None

If host is not specified in a proxy, Ice uses the value of the Ice.Default.Host property. If that property is not defined, outgoing connections are only attempted over loopback interfaces.

If host is not specified in an object adapter endpoint, Ice uses the value of the Ice.Default.Host property. If that property is not defined, the adapter behaves as if the wildcard symbol * was specified (see below).

Host name

The host name is resolved via DNS. Outgoing connections are attempted to each address returned by the DNS query.

The host name is resolved via DNS, and the object adapter listens on the network

interfaces

interface corresponding to

each

the first address returned by the DNS query. The specified host name is embedded in proxies created by the adapter.

IPv4 address

An outgoing connection is attempted to the given address.

The object adapter listens on the network interface corresponding to the address. The specified address is embedded in proxies created by the adapter.

IPv6 address

An outgoing connection is attempted to the given address.

The object adapter listens on the network interface corresponding to the address. The specified address is embedded in proxies created by the adapter.

0.0.0.0 (IPv4)

A "wildcard" IPv4 address that causes Ice to try all local interfaces when establishing an outgoing connection.

Equivalent to * (see below).

"::" (IPv6)

A "wildcard" IPv6 address that causes Ice to try all local interfaces when establishing an outgoing connection.

Equivalent to * (see below).

* (IPv4, IPv6)

Not supported in proxies.

The adapter listens on all network interfaces (including the loopback interface), that is, binds to INADDR_ANY for the enabled protocols (IPv4 and/or IPv6). Endpoints for all addresses except loopback and IPv6 link-local are published in proxies (unless loopback is the only available interface, in which case only loopback is published).
Using Mono, proxies created by an object adapter listening on the IPv6 wildcard address contain only the IPv6 loopback address unless published endpoints are configured.

There is one additional benefit in specifying a wildcard address for host (or not specifying it at all) in an object adapter's endpoint: if the list of network interfaces on a host may change while the application is running, using a wildcard address for host ensures that the object adapter automatically includes the updated interfaces. Note however that the list of published endpoints is not changed automatically; rather, the application must explicitly refresh the object adapter's endpoints. For diagnostic purposes, you can set the configuration property Ice.Trace.Network=3 to cause Ice to log the current list of local addresses that it is substituting for the wildcard address.

...

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.

See #Address Syntax.

See #Address Syntax.

-p port

Specifies the port number of the endpoint.

Determines the port to which a connection attempt is made (required).

The port will be selected by the operating system if this option is not specified or port is zero.

-t timeout

Specifies the endpoint timeout in milliseconds.

If timeout is greater than zero, it specifies the timeout used by the client to open or close connections and to read or write data. It also specifies how long the run time waits for an invocation to complete. If a timeout occurs, the application receives Ice::TimeoutException

If timeout is greater than zero, it specifies the timeout used by the server to accept or close connections and to read or write data (see Timeouts in Object Adapter Endpoints and Connection Timeouts). timeout also controls the timeout that is published in proxies created by the object adapter.

-z

Specifies bzip2 compression.

Determines whether compressed requests are sent.

Determines whether compression is advertised in proxies created by the adapter.

UDP Endpoint Syntax

Synopsis

...

A udp endpoint supports the following options:

Option

Description

Client Semantics

Server Semantics

-v major.minor

The protocol version to use when sending a request to the target object. This option is deprecated as of Ice 3.5. Its default value is 1.0; if specified, it must be set to 1.0 as well.

 

 

-e major.minor

The encoding version to use when sending a request to the target object. This option is deprecated as of Ice 3.5. Its default value is 1.0; if specified, it must be set to 1.0 as well.

 

 

-h host

Specifies the host name or IP address of the endpoint. If not specified, the value of Ice.Default.Host is used instead.

See Address Syntax.

See Address Syntax.

-p port

Specifies the port number of the endpoint.

Determines the port to which datagrams are sent (required).

The port will be selected by the operating system if this option is not specified or port is zero.

-z

Specifies bzip2 compression.

Determines whether compressed requests are sent.

Determines whether compression is advertised in proxies created by the adapter.

--ttl TTL

Specifies the time-to-live (also known as "hops") of multicast messages.

Determines whether multicast messages are forwarded beyond the local network. If not specified, or the value of TTL is -1, multicast messages are not forwarded. The maximum value is 255.

N/A

--interface INTF

Specifies the network interface or group for multicast messages (see below).

Selects the network interface for outgoing multicast messages. If not specified, multicast messages are sent using the default interface.

Selects the network interface to use when joining the multicast group. If not specified, the group is joined on the default network interface.

Multicast Interfaces

When host denotes a multicast address, the --interface INTF option selects a particular network interface to be used for communication. The format of INTF depends on the language and IP version:

...

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.

See #Address Syntax.

See #Address Syntax.

-p port

Specifies the port number of the endpoint.

Determines the port to which a connection attempt is made (required).

The port will be selected by the operating system if this option is not specified or port is zero.

-t timeout

Specifies the endpoint timeout in milliseconds.

If timeout is greater than zero, it specifies the timeout used by the client to open or close connections and to read or write data. It also specifies how long the run time waits for an invocation to complete. If a timeout occurs, the application receives Ice::TimeoutException.

If timeout is greater than zero, it specifies the timeout used by the server to accept or close connections and to read or write data (see Timeouts in Object Adapter Endpoints and Connection Timeouts). timeout also controls the timeout that is published in proxies created by the object adapter.

-z

Specifies bzip2 compression.

Determines whether compressed requests are sent.

Determines whether compression is advertised in proxies created by the adapter.

Ztop

Opaque Endpoint Syntax

...

An opaque endpoint supports the following options:

Option

Description

-t type

Specifies the transport for the endpoint. Transports are indicated by positive integers (1 for TCP, 2 for SSL, and 3 for UDP).

-v value

Specifies the marshaled encoding of the endpoint (including its enclosing encapsulation) in base-64 encoding.

Exactly one each of the -t and -v options must be present in an opaque endpoint.

...