ConnectionI (ice 3.6.5 API)

java.lang.Object
- IceInternal.EventHandler
- - Ice.ConnectionI

All Implemented Interfaces:: Connection, CancellationHandler, ResponseHandler

public final class ConnectionI
extends EventHandler
implements Connection, ResponseHandler, CancellationHandler

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ConnectionI.StartCallback

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ConnectionI.StartCallback`

Field Summary

Fields
Modifier and Type Field and Description

static int CommunicatorDestroyed

static int ObjectAdapterDeactivated
- Fields inherited from class IceInternal.EventHandler
  _disabled, _hasMoreData, _key, _registered
- Fields inherited from interface Ice.Connection
  serialVersionUID

Fields
Modifier and Type	Field and Description
`static int`	`CommunicatorDestroyed`
`static int`	`ObjectAdapterDeactivated`

Constructor Summary

Constructors
Constructor and Description
`ConnectionI(Communicator communicator, Instance instance, ACMMonitor monitor, Transceiver transceiver, Connector connector, EndpointI endpoint, ObjectAdapterI adapter)`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`void`	`activate()`
`void`	`asyncRequestCanceled(OutgoingAsyncBase outAsync, LocalException ex)`
`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.
`Connector`	`connector()`
`ObjectPrx`	`createProxy(Identity ident)` Create a special proxy that always uses this connection.
`void`	`destroy(int reason)`
`protected void`	`dispatch(ConnectionI.StartCallback startCB, java.util.List<Ice.ConnectionI.OutgoingMessage> sentCBs, Ice.ConnectionI.MessageInfo info)`
`void`	`end_flushBatchRequests(AsyncResult ir)` Flush any pending batch requests for this connection.
`EndpointI`	`endpoint()`
`void`	`exception(LocalException ex)`
`java.nio.channels.SelectableChannel`	`fd()`
`protected void`	`finalize()`
`void`	`finish(boolean close)`
`void`	`finished(ThreadPoolCurrent current, boolean close)`
`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.
`BatchRequestQueue`	`getBatchRequestQueue()`
`Endpoint`	`getEndpoint()` Get the endpoint from which the connection was created.
`ConnectionInfo`	`getInfo()` Returns the connection information.
`void`	`hold()`
`void`	`invokeException(int requestId, LocalException ex, int invokeNum, boolean amd)`
`boolean`	`isActiveOrHolding()`
`boolean`	`isFinished()`
`void`	`message(ThreadPoolCurrent current)`
`void`	`monitor(long now, ACMConfig acm)`
`int`	`sendAsyncRequest(OutgoingAsyncBase out, boolean compress, boolean response, int batchRequestNum)`
`void`	`sendNoResponse()`
`void`	`sendResponse(int requestId, BasicStream os, byte compressFlag, boolean amd)`
`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.
`void`	`start(ConnectionI.StartCallback callback)`
`void`	`startAndWait()`
`boolean`	`systemException(int requestId, SystemException ex, boolean amd)`
`void`	`throwException()`
`void`	`timedOut()`
`int`	`timeout()` Get the timeout for the connection.
`java.lang.String`	`toString()`
`java.lang.String`	`type()` Return the connection type.
`void`	`updateObserver()`
`void`	`waitUntilFinished()`
`void`	`waitUntilHolding()`

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ObjectAdapterDeactivated
```
public static final int ObjectAdapterDeactivated
```
    See Also:
    
    Constant Field Values
  - CommunicatorDestroyed
```
public static final int CommunicatorDestroyed
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ConnectionI
```
public ConnectionI(Communicator communicator,
                   Instance instance,
                   ACMMonitor monitor,
                   Transceiver transceiver,
                   Connector connector,
                   EndpointI endpoint,
                   ObjectAdapterI adapter)
```
- Method Detail
  - start
```
public void start(ConnectionI.StartCallback callback)
```
  - startAndWait
```
public void startAndWait()
                  throws java.lang.InterruptedException
```
    Throws:
    
    java.lang.InterruptedException
  - activate
```
public void activate()
```
  - hold
```
public void hold()
```
  - destroy
```
public void destroy(int reason)
```
  - close
```
public void close(boolean force)
```
    Description copied from interface: Connection
    
    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.
    
    Specified by:
    
    close in interface Connection
    
    Parameters:
    
    force - If true, close forcefully. Otherwise the connection is closed gracefully.
  - isActiveOrHolding
```
public boolean isActiveOrHolding()
```
  - isFinished
```
public boolean isFinished()
```
  - throwException
```
public void throwException()
```
  - waitUntilHolding
```
public void waitUntilHolding()
                      throws java.lang.InterruptedException
```
    Throws:
    
    java.lang.InterruptedException
  - waitUntilFinished
```
public void waitUntilFinished()
                       throws java.lang.InterruptedException
```
    Throws:
    
    java.lang.InterruptedException
  - updateObserver
```
public void updateObserver()
```
  - monitor
```
public void monitor(long now,
                    ACMConfig acm)
```
  - sendAsyncRequest
```
public int sendAsyncRequest(OutgoingAsyncBase out,
                            boolean compress,
                            boolean response,
                            int batchRequestNum)
                     throws RetryException
```
    Throws:
    
    RetryException
  - getBatchRequestQueue
```
public BatchRequestQueue getBatchRequestQueue()
```
  - flushBatchRequests
```
public void flushBatchRequests()
```
    Description copied from interface: Connection
    
    Flush any pending batch requests for this connection. This means all batch requests invoked on fixed proxies associated with the connection.
    
    Specified by:
    
    flushBatchRequests in interface Connection
  - begin_flushBatchRequests
```
public AsyncResult begin_flushBatchRequests()
```
    Description copied from interface: Connection
    
    Flush any pending batch requests for this connection. This means all batch requests invoked on fixed proxies associated with the connection.
    
    Specified by:
    
    begin_flushBatchRequests in interface Connection
    
    Returns:
    
    The asynchronous result object.
  - begin_flushBatchRequests
```
public AsyncResult begin_flushBatchRequests(Callback cb)
```
    Description copied from interface: Connection
    
    Flush any pending batch requests for this connection. This means all batch requests invoked on fixed proxies associated with the connection.
    
    Specified by:
    
    begin_flushBatchRequests in interface Connection
    
    Parameters:
    
    cb - A generic callback.
    
    Returns:
    
    The asynchronous result object.
  - begin_flushBatchRequests
```
public AsyncResult begin_flushBatchRequests(Callback_Connection_flushBatchRequests cb)
```
    Description copied from interface: Connection
    
    Flush any pending batch requests for this connection. This means all batch requests invoked on fixed proxies associated with the connection.
    
    Specified by:
    
    begin_flushBatchRequests in interface Connection
    
    Parameters:
    
    cb - A typed callback.
    
    Returns:
    
    The asynchronous result object.
  - begin_flushBatchRequests
```
public AsyncResult begin_flushBatchRequests(Functional_VoidCallback __responseCb,
                                            Functional_GenericCallback1<Exception> __exceptionCb,
                                            Functional_BoolCallback __sentCb)
```
    Description copied from interface: Connection
    
    Flush any pending batch requests for this connection. This means all batch requests invoked on fixed proxies associated with the connection.
    
    Specified by:
    
    begin_flushBatchRequests in interface Connection
    
    Parameters:
    
    __responseCb - The response callback.
    
    __exceptionCb - The exception callback.
    
    __sentCb - The sent callback.
    
    Returns:
    
    The asynchronous result object.
  - end_flushBatchRequests
```
public void end_flushBatchRequests(AsyncResult ir)
```
    Description copied from interface: Connection
    
    Flush any pending batch requests for this connection. This means all batch requests invoked on fixed proxies associated with the connection.
    
    Specified by:
    
    end_flushBatchRequests in interface Connection
    
    Parameters:
    
    ir - The asynchronous result object.
  - setCallback
```
public void setCallback(ConnectionCallback callback)
```
    Description copied from interface: Connection
    
    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.
    
    Specified by:
    
    setCallback in interface Connection
    
    Parameters:
    
    callback - The connection callback object.
  - setACM
```
public void setACM(IntOptional timeout,
                   Optional<ACMClose> close,
                   Optional<ACMHeartbeat> heartbeat)
```
    Description copied from interface: Connection
    
    Set the active connection management parameters.
    
    Specified by:
    
    setACM in interface Connection
    
    Parameters:
    
    timeout - The timeout value in seconds.
    
    close - The close condition
    
    heartbeat - The hertbeat condition
  - getACM
```
public ACM getACM()
```
    Description copied from interface: Connection
    
    Get the ACM parameters.
    
    Specified by:
    
    getACM in interface Connection
    
    Returns:
    
    The ACM parameters.
  - asyncRequestCanceled
```
public void asyncRequestCanceled(OutgoingAsyncBase outAsync,
                                 LocalException ex)
```
    Specified by:
    
    asyncRequestCanceled in interface CancellationHandler
  - sendResponse
```
public void sendResponse(int requestId,
                         BasicStream os,
                         byte compressFlag,
                         boolean amd)
```
    Specified by:
    
    sendResponse in interface ResponseHandler
  - sendNoResponse
```
public void sendNoResponse()
```
    Specified by:
    
    sendNoResponse in interface ResponseHandler
  - systemException
```
public boolean systemException(int requestId,
                               SystemException ex,
                               boolean amd)
```
    Specified by:
    
    systemException in interface ResponseHandler
  - invokeException
```
public void invokeException(int requestId,
                            LocalException ex,
                            int invokeNum,
                            boolean amd)
```
    Specified by:
    
    invokeException in interface ResponseHandler
  - endpoint
```
public EndpointI endpoint()
```
  - connector
```
public Connector connector()
```
  - setAdapter
```
public void setAdapter(ObjectAdapter adapter)
```
    Description copied from interface: Connection
    
    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.
    
    Specified by:
    
    setAdapter in interface Connection
    
    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:
    
    Connection.createProxy(Ice.Identity), Connection.setAdapter(Ice.ObjectAdapter)
  - getAdapter
```
public ObjectAdapter getAdapter()
```
    Description copied from interface: Connection
    
    Get the object adapter that dispatches requests for this connection.
    
    Specified by:
    
    getAdapter in interface Connection
    
    Returns:
    
    The object adapter that dispatches requests for the connection, or null if no adapter is set.
    
    See Also:
    
    Connection.setAdapter(Ice.ObjectAdapter)
  - getEndpoint
```
public Endpoint getEndpoint()
```
    Description copied from interface: Connection
    
    Get the endpoint from which the connection was created.
    
    Specified by:
    
    getEndpoint in interface Connection
    
    Returns:
    
    The endpoint from which the connection was created.
  - createProxy
```
public ObjectPrx createProxy(Identity ident)
```
    Description copied from interface: Connection
    
    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.
    
    Specified by:
    
    createProxy in interface Connection
    
    Parameters:
    
    ident - The identity for which a proxy is to be created.
    
    Returns:
    
    A proxy that matches the given identity and uses this connection.
    
    See Also:
    
    Connection.setAdapter(Ice.ObjectAdapter)
  - message
```
public void message(ThreadPoolCurrent current)
```
    Specified by:
    
    message in class EventHandler
  - dispatch
```
protected void dispatch(ConnectionI.StartCallback startCB,
                        java.util.List<Ice.ConnectionI.OutgoingMessage> sentCBs,
                        Ice.ConnectionI.MessageInfo info)
```
  - finished
```
public void finished(ThreadPoolCurrent current,
                     boolean close)
```
    Specified by:
    
    finished in class EventHandler
  - finish
```
public void finish(boolean close)
```
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in class EventHandler
  - fd
```
public java.nio.channels.SelectableChannel fd()
```
    Specified by:
    
    fd in class EventHandler
  - timedOut
```
public void timedOut()
```
  - type
```
public java.lang.String type()
```
    Description copied from interface: Connection
    
    Return the connection type. This corresponds to the endpoint type, i.e., "tcp", "udp", etc.
    
    Specified by:
    
    type in interface Connection
    
    Returns:
    
    The type of the connection.
  - timeout
```
public int timeout()
```
    Description copied from interface: Connection
    
    Get the timeout for the connection.
    
    Specified by:
    
    timeout in interface Connection
    
    Returns:
    
    The connection's timeout.
  - getInfo
```
public ConnectionInfo getInfo()
```
    Description copied from interface: Connection
    
    Returns the connection information.
    
    Specified by:
    
    getInfo in interface Connection
    
    Returns:
    
    The connection information.
  - setBufferSize
```
public void setBufferSize(int rcvSize,
                          int sndSize)
```
    Description copied from interface: Connection
    
    Set the connectiion buffer receive/send size.
    
    Specified by:
    
    setBufferSize in interface Connection
    
    Parameters:
    
    rcvSize - The connection receive buffer size.
    
    sndSize - The connection send buffer size.
  - _toString
```
public java.lang.String _toString()
```
    Description copied from interface: Connection
    
    Return a description of the connection as human readable text, suitable for logging or error messages.
    
    Specified by:
    
    _toString in interface Connection
    
    Returns:
    
    The description of the connection as human readable text.
  - exception
```
public void exception(LocalException ex)
```
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable

Class ConnectionI

Nested Class Summary

Field Summary

Fields inherited from class IceInternal.EventHandler

Fields inherited from interface Ice.Connection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ObjectAdapterDeactivated

CommunicatorDestroyed

Constructor Detail

ConnectionI

Method Detail

start

startAndWait

activate

hold

destroy

close

isActiveOrHolding

isFinished

throwException

waitUntilHolding

waitUntilFinished

updateObserver

monitor

sendAsyncRequest

getBatchRequestQueue

flushBatchRequests

begin_flushBatchRequests

begin_flushBatchRequests

begin_flushBatchRequests

begin_flushBatchRequests

end_flushBatchRequests

setCallback

setACM

getACM

asyncRequestCanceled

sendResponse

sendNoResponse

systemException

invokeException

endpoint

connector

setAdapter

getAdapter

getEndpoint

createProxy

message

dispatch

finished

finish

toString

fd

timedOut

type

timeout

getInfo

setBufferSize

_toString

exception

finalize