Ice

Interface Connection

All Known Implementing Classes:

ConnectionI

public interface Connection

The user-level interface to a connection.

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.lang.String	_toString() Return a description of the connection as human readable text, suitable for logging or error messages.
AsyncResult	begin_flushBatchRequests() Flush any pending batch requests for this connection.
AsyncResult	begin_flushBatchRequests(Callback_Connection_flushBatchRequests __cb) Flush any pending batch requests for this connection.
AsyncResult	begin_flushBatchRequests(Callback __cb) Flush any pending batch requests for this connection.
AsyncResult	begin_flushBatchRequests(Functional_VoidCallback __responseCb, Functional_GenericCallback1<Exception> __exceptionCb, Functional_BoolCallback __sentCb) Flush any pending batch requests for this connection.
void	close(boolean force) Close a connection, either gracefully or forcefully.
ObjectPrx	createProxy(Identity id) Create a special proxy that always uses this connection.
void	end_flushBatchRequests(AsyncResult __result) Flush any pending batch requests for this connection.
void	flushBatchRequests() Flush any pending batch requests for this connection.
ACM	getACM() Get the ACM parameters.
ObjectAdapter	getAdapter() Get the object adapter that dispatches requests for this connection.
Endpoint	getEndpoint() Get the endpoint from which the connection was created.
ConnectionInfo	getInfo() Returns the connection information.
void	setACM(IntOptional timeout, Optional<ACMClose> close, Optional<ACMHeartbeat> heartbeat) Set the active connection management parameters.
void	setAdapter(ObjectAdapter adapter) Explicitly set an object adapter that dispatches requests that are received over this connection.
void	setBufferSize(int rcvSize, int sndSize) Set the connectiion buffer receive/send size.
void	setCallback(ConnectionCallback callback) Set callback on the connection.
int	timeout() Get the timeout for the connection.
java.lang.String	type() Return the connection type.

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

close

void close(boolean 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

ObjectPrx 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(Ice.ObjectAdapter)

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(Ice.Identity), setAdapter(Ice.ObjectAdapter)

getAdapter

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(Ice.ObjectAdapter)

getEndpoint

Endpoint getEndpoint()

Get the endpoint from which the connection was created.

Returns:

The endpoint from which the connection was created.

flushBatchRequests

void flushBatchRequests()

Flush any pending batch requests for this connection. This means all batch requests invoked on fixed proxies associated with the connection.

begin_flushBatchRequests

AsyncResult begin_flushBatchRequests()

Flush any pending batch requests for this connection. This means all batch requests invoked on fixed proxies associated with the connection.

Returns:

The asynchronous result object.

begin_flushBatchRequests

AsyncResult begin_flushBatchRequests(Callback __cb)

Flush any pending batch requests for this connection. This means all batch requests invoked on fixed proxies associated with the connection.

Parameters:

__cb - A generic callback.

Returns:

The asynchronous result object.

begin_flushBatchRequests

AsyncResult begin_flushBatchRequests(Callback_Connection_flushBatchRequests __cb)

Flush any pending batch requests for this connection. This means all batch requests invoked on fixed proxies associated with the connection.

Parameters:

__cb - A typed callback.

Returns:

The asynchronous result object.

begin_flushBatchRequests

AsyncResult begin_flushBatchRequests(Functional_VoidCallback __responseCb,
                                     Functional_GenericCallback1<Exception> __exceptionCb,
                                     Functional_BoolCallback __sentCb)

Flush any pending batch requests for this connection. This means all batch requests invoked on fixed proxies associated with the connection.

Parameters:

__responseCb - The response callback.

__exceptionCb - The exception callback.

__sentCb - The sent callback.

Returns:

The asynchronous result object.

end_flushBatchRequests

void end_flushBatchRequests(AsyncResult __result)

Flush any pending batch requests for this connection. This means all batch requests invoked on fixed proxies associated with the connection.

Parameters:

__result - The asynchronous result object.

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.

setACM

void setACM(IntOptional timeout,
            Optional<ACMClose> close,
            Optional<ACMHeartbeat> heartbeat)

Set the active connection management parameters.

Parameters:

timeout - The timeout value in seconds.

close - The close condition

heartbeat - The hertbeat condition

getACM

ACM getACM()

Get the ACM parameters.

Returns:

The ACM parameters.

type

java.lang.String type()

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

Returns:

The type of the connection.

timeout

int timeout()

Get the timeout for the connection.

Returns:

The connection's timeout.

_toString

java.lang.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.

getInfo

ConnectionInfo getInfo()

Returns the connection information.

Returns:

The connection information.

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.