Ice::Connection Local Interface Reference

The user-level interface to a connection. More...

Defined in <Ice/Connection.ice>

local interface Connection { ... }

Operations
void	close (bool force)
	Close a connection, either gracefully or forcefully. More...
Object *	createProxy (Identity id)
	Create a special proxy that always uses this connection. More...
void	flushBatchRequests ()
	Flush any pending batch requests for this connection. More...
ACM	getACM ()
	Get the ACM parameters. More...
ObjectAdapter	getAdapter ()
	Get the object adapter that dispatches requests for this connection. More...
Endpoint	getEndpoint ()
	Get the endpoint from which the connection was created. More...
ConnectionInfo	getInfo ()
	Returns the connection information. More...
void	setACM (optional(1) int timeout, optional(2) ACMClose close, optional(3) ACMHeartbeat heartbeat)
	Set the active connection management parameters. More...
void	setAdapter (ObjectAdapter adapter)
	Explicitly set an object adapter that dispatches requests that are received over this connection. More...
void	setBufferSize (int rcvSize, int sndSize)
	Set the connectiion buffer receive/send size. More...
void	setCallback (ConnectionCallback callback)
	Set callback on the connection. More...
int	timeout ()
	Get the timeout for the connection. More...
string	toString ()
	Return a description of the connection as human readable text, suitable for logging or error messages. More...
string	type ()
	Return the connection type. More...

Detailed Description

The user-level interface to a connection.

Operation Documentation

close()

void close

(

bool

force

)

Close a connection, either gracefully or forcefully.

If a connection is closed forcefully, it closes immediately, without sending the relevant close connection protocol messages to the peer and waiting for the peer to acknowledge these protocol messages.

Parameters

force

If true, close forcefully. Otherwise the connection is closed gracefully.

createProxy()

["cpp:const"]

Object* createProxy

(

Identity

id

)

Create a special proxy that always uses this connection.

This can be used for callbacks from a server to a client if the server cannot directly establish a connection to the client, for example because of firewalls. In this case, the server would create a proxy using an already established connection from the client.

Parameters

id	The identity for which a proxy is to be created.

Returns

A proxy that matches the given identity and uses this connection.

See also

setAdapter

flushBatchRequests()

["async"]

void flushBatchRequests

(

)

Flush any pending batch requests for this connection.

This means all batch requests invoked on fixed proxies associated with the connection.

getACM()

ACM getACM

(

)

Get the ACM parameters.

Returns

The ACM parameters.

getAdapter()

["cpp:const"]

ObjectAdapter getAdapter

(

)

Get the object adapter that dispatches requests for this connection.

Returns

The object adapter that dispatches requests for the connection, or null if no adapter is set.

See also

setAdapter

getEndpoint()

["cpp:const"]

Endpoint getEndpoint

(

)

Get the endpoint from which the connection was created.

Returns

The endpoint from which the connection was created.

getInfo()

["cpp:const"]

ConnectionInfo getInfo

(

)

Returns the connection information.

Returns

The connection information.

setACM()

["java:optional"]

void setACM	(	optional(1) int	timeout,
		optional(2) ACMClose	close,
		optional(3) ACMHeartbeat	heartbeat
	)

Set the active connection management parameters.

Parameters

timeout	The timeout value in seconds.
close	The close condition
heartbeat	The hertbeat condition

setAdapter()

void setAdapter

(

ObjectAdapter

adapter

)

Explicitly set an object adapter that dispatches requests that are received over this connection.

A client can invoke an operation on a server using a proxy, and then set an object adapter for the outgoing connection that is used by the proxy in order to receive callbacks. This is useful if the server cannot establish a connection back to the client, for example because of firewalls.

Parameters

adapter

The object adapter that should be used by this connection to dispatch requests. The object adapter must be activated. When the object adapter is deactivated, it is automatically removed from the connection.

See also

createProxy

setAdapter

setBufferSize()

void setBufferSize	(	int	rcvSize,
		int	sndSize
	)

Set the connectiion buffer receive/send size.

Parameters

rcvSize	The connection receive buffer size.
sndSize	The connection send buffer size.

setCallback()

void setCallback

(

ConnectionCallback

callback

)

Set callback on the connection.

The callback is called by the connection when it's closed. The callback is called from the Ice thread pool associated with the connection.

Parameters

callback

The connection callback object.

timeout()

["cpp:const"]

int timeout

(

)

Get the timeout for the connection.

Returns

The connection's timeout.

toString()

["cpp:const"]

string toString

(

)

Return a description of the connection as human readable text, suitable for logging or error messages.

Returns

The description of the connection as human readable text.

type()

["cpp:const"]

string type

(

)

Return the connection type.

This corresponds to the endpoint type, i.e., "tcp", "udp", etc.

Returns

The type of the connection.

---

The documentation for this interface was generated from the following file:

• Ice/Connection.ice