ConnectionImpl (GlassFish Corba ORB 4.2.1 API)

java.lang.Object
- com.sun.corba.ee.impl.transport.EventHandlerBase
- - com.sun.corba.ee.impl.transport.ConnectionImpl

All Implemented Interfaces:

Connection, Work, EventHandler

Direct Known Subclasses:

SocketFactoryConnectionImpl
```
public class ConnectionImpl
extends EventHandlerBase
implements Connection, Work
```
Author:

Harold Carr
Note: this is the version WITHOUT the purgeCalls changes. The changes are in the 1.106 version, which is saved as SocketOrChannelConnectionImpl.1.106.sjava.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Acceptor`	`acceptor`
`protected ByteBuffer`	`byteBuffer`
`protected CachedCodeBase`	`cachedCodeBase`
`protected MessageMediator`	`clientReply_1_1`
`protected IOR`	`codeBaseServerIOR`
`protected CodeSetComponentInfo.CodeSetContext`	`codeSetContext`
`protected ConnectionCache`	`connectionCache`
`protected ContactInfo`	`contactInfo`
`protected com.sun.corba.ee.impl.transport.ConnectionImpl.Dispatcher`	`dispatcher`
`protected long`	`enqueueTime`
`protected ConcurrentHashMap<RequestId,Queue<MessageMediator>>`	`fragmentMap`
`protected boolean`	`isServer`
`protected boolean`	`postInitialContexts`
`protected AtomicInteger`	`requestId`
`protected ResponseWaitingRoom`	`responseWaitingRoom`
`protected MessageMediator`	`serverRequest_1_1`
`protected int`	`serverRequestCount`
`protected Socket`	`socket`
`protected SocketChannel`	`socketChannel`
`protected Object`	`stateEvent`
`protected TcpTimeouts`	`tcpTimeouts`
`protected long`	`timeStamp`
`protected TemporarySelector`	`tmpReadSelector`
`protected Object`	`tmpReadSelectorLock`
`protected static ORBUtilSystemException`	`wrapper`
`protected Object`	`writeEvent`
`protected boolean`	`writeLocked`

Fields inherited from class com.sun.corba.ee.impl.transport.EventHandlerBase
orb, selectionKey, useSelectThreadToWait, useWorkerThreadForEvent, work

Fields inherited from interface com.sun.corba.ee.spi.transport.Connection
ABORT, CLOSE_RECVD, CLOSE_SENT, ESTABLISHED, OPENING

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ConnectionImpl(ORB orb)`
	`ConnectionImpl(ORB orb, Acceptor acceptor, Socket socket)`
`protected`	`ConnectionImpl(ORB orb, boolean useSelectThreadToWait, boolean useWorkerThread)`
	`ConnectionImpl(ORB orb, ContactInfo contactInfo, String socketType, String hostname, int port)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`blockingRead()`
`MessageMediator`	`clientReply_1_1_Get()`
`void`	`clientReply_1_1_Put(MessageMediator x)`
`void`	`clientReply_1_1_Remove()`
`MessageMediator`	`clientRequestMapGet(int requestId)`
`void`	`close()` Note:it is possible for this to be called more than once
`void`	`closeConnectionResources()` Clean up all connection resources.
`protected void`	`closeSocketAndTemporarySelectors()`
`protected void`	`closeTemporarySelectors()`
`protected void`	`defineSocket(boolean useSelectThreadToWait, Socket socket)`
`protected void`	`doOptimizedReadStrategy()`
`void`	`doWork()`
`ByteBuffer`	`extractAndProcessMessages(ByteBuffer byteBuffer)`
`Acceptor`	`getAcceptor()`
`ORB`	`getBroker()`
`SelectableChannel`	`getChannel()`
`CodeBase`	`getCodeBase()`
`IOR`	`getCodeBaseIOR()`
`CodeSetComponentInfo.CodeSetContext`	`getCodeSetContext()`
`Connection`	`getConnection()`
`ConnectionCache`	`getConnectionCache()`
`ContactInfo`	`getContactInfo()`
`long`	`getEnqueueTime()`
`EventHandler`	`getEventHandler()`
`Queue<MessageMediator>`	`getFragmentList(RequestId corbaRequestId)`
`int`	`getInterestOps()`
`String`	`getName()`
`int`	`getNextRequestId()`
`ResponseWaitingRoom`	`getResponseWaitingRoom()`
`Socket`	`getSocket()`
`SocketChannel`	`getSocketChannel()`
`protected int`	`getState()`
`protected String`	`getStateString(int state)`
`protected TemporarySelector`	`getTemporaryReadSelector()`
`long`	`getTimeStamp()` Timestamps are used for connection management, in particular, for reclaiming idle `Connection`s.
`boolean`	`hasSocketChannel()`
`boolean`	`isBusy()` Indicates if the `Connection` is in the process of sending or receiving a message.
`boolean`	`isClosed()` Indicates if the `Connection` is closed.
`boolean`	`isPostInitialContexts()`
`boolean`	`isServer()` Indicates whether a CorbaContactInfo or CorbaAcceptor created the `Connection`.
`protected int`	`nonBlockingRead()`
`void`	`purgeCalls(SystemException systemException, boolean die, boolean lockHeld)` Wake up the outstanding requests on the connection, and hand them COMM_FAILURE exception with a given minor code.
`boolean`	`read()` Called to read incoming messages.
`void`	`registerWaiter(MessageMediator messageMediator)` Register an invocation's CorbaMessageMediator with the `Connection`.
`void`	`removeFragmentList(RequestId corbaRequestId)`
`void`	`sendCancelRequest(GIOPVersion giopVersion, int requestId)` Send a CancelRequest message.
`void`	`sendCancelRequestWithLock(GIOPVersion giopVersion, int requestId)`
`void`	`sendCloseConnection(GIOPVersion giopVersion)` ********************************************************************** The following methods are for dealing with Connection cleaning for better scalability of servers in high network load conditions.
`protected void`	`sendHelper(GIOPVersion giopVersion, Message msg)`
`void`	`sendMessageError(GIOPVersion giopVersion)`
`void`	`sendWithoutLock(CDROutputObject outputObject)`
`MessageMediator`	`serverRequest_1_1_Get()`
`void`	`serverRequest_1_1_Put(MessageMediator x)`
`void`	`serverRequest_1_1_Remove()`
`MessageMediator`	`serverRequestMapGet(int reqId)`
`void`	`serverRequestMapPut(int reqId, MessageMediator messageMediator)`
`void`	`serverRequestMapRemove(int reqId)`
`void`	`serverRequestProcessingBegins()` It is possible for a Close Connection to have been * sent here, but we will not check for this.
`void`	`serverRequestProcessingEnds()`
`void`	`setCodeBaseIOR(IOR ior)`
`void`	`setCodeSetContext(CodeSetComponentInfo.CodeSetContext csc)`
`void`	`setConnectionCache(ConnectionCache connectionCache)`
`void`	`setEnqueueTime(long timeInMillis)`
`void`	`setPostInitialContexts()`
`protected void`	`setState(int state)`
`void`	`setState(String stateString)` The "state" of the `Connection`.
`protected void`	`setTcpTimeouts(TcpTimeouts tcpTimeouts)`
`void`	`setTimeStamp(long time)` Timestamps are used for connection management, in particular, for reclaiming idle `Connection`s.
`void`	`setUseSelectThreadToWait(boolean x)`
`boolean`	`shouldRegisterReadEvent()` Used to determine if the `Connection` should register with the CorbaTransportManager Selector to handle read events.
`boolean`	`shouldRegisterServerReadEvent()` Used to determine if the `Connection` should register with the CorbaTransportManager Selector to handle read events.
`String`	`toString()`
`void`	`unregisterWaiter(MessageMediator messageMediator)` Unregister an invocation's * CorbaMessageMediator with the `Connection`.
`CDRInputObject`	`waitForResponse(MessageMediator messageMediator)` If a message expect's a response then this method is called.
`void`	`write(ByteBuffer byteBuffer)`
`void`	`writeLock()` Sets the writeLock for this connection.
`void`	`writeUnlock()` Release a write lock on the `Connection`.

Methods inherited from class com.sun.corba.ee.impl.transport.EventHandlerBase
getSelectionKey, getWork, handleEvent, setSelectionKey, setUseWorkerThreadForEvent, setWork, shouldUseSelectThreadToWait, shouldUseWorkerThreadForEvent

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

- Field Detail
  - wrapper
```
protected static final ORBUtilSystemException wrapper
```
  - socketChannel
```
protected SocketChannel socketChannel
```
  - byteBuffer
```
protected ByteBuffer byteBuffer
```
  - enqueueTime
```
protected long enqueueTime
```
  - contactInfo
```
protected ContactInfo contactInfo
```
  - acceptor
```
protected Acceptor acceptor
```
  - connectionCache
```
protected ConnectionCache connectionCache
```
  - socket
```
protected Socket socket
```
  - timeStamp
```
protected long timeStamp
```
  - isServer
```
protected boolean isServer
```
  - requestId
```
protected AtomicInteger requestId
```
  - responseWaitingRoom
```
protected ResponseWaitingRoom responseWaitingRoom
```
  - stateEvent
```
protected final Object stateEvent
```
  - writeEvent
```
protected final Object writeEvent
```
  - writeLocked
```
protected boolean writeLocked
```
  - serverRequestCount
```
protected int serverRequestCount
```
  - postInitialContexts
```
protected boolean postInitialContexts
```
  - codeBaseServerIOR
```
protected IOR codeBaseServerIOR
```
  - cachedCodeBase
```
protected CachedCodeBase cachedCodeBase
```
  - tcpTimeouts
```
protected TcpTimeouts tcpTimeouts
```
  - tmpReadSelector
```
protected TemporarySelector tmpReadSelector
```
  - tmpReadSelectorLock
```
protected final Object tmpReadSelectorLock
```
  - dispatcher
```
protected com.sun.corba.ee.impl.transport.ConnectionImpl.Dispatcher dispatcher
```
  - fragmentMap
```
protected ConcurrentHashMap<RequestId,Queue<MessageMediator>> fragmentMap
```
  - codeSetContext
```
protected CodeSetComponentInfo.CodeSetContext codeSetContext
```
  - clientReply_1_1
```
protected MessageMediator clientReply_1_1
```
  - serverRequest_1_1
```
protected MessageMediator serverRequest_1_1
```
- Constructor Detail
  - ConnectionImpl
```
public ConnectionImpl(ORB orb)
```
  - ConnectionImpl
```
protected ConnectionImpl(ORB orb,
                         boolean useSelectThreadToWait,
                         boolean useWorkerThread)
```
  - ConnectionImpl
```
public ConnectionImpl(ORB orb,
                      ContactInfo contactInfo,
                      String socketType,
                      String hostname,
                      int port)
```
  - ConnectionImpl
```
public ConnectionImpl(ORB orb,
                      Acceptor acceptor,
                      Socket socket)
```
- Method Detail
  - getSocketChannel
```
public SocketChannel getSocketChannel()
```
  - defineSocket
```
protected final void defineSocket(boolean useSelectThreadToWait,
                                  Socket socket)
                           throws IOException
```
    Throws:
    
    IOException
  - shouldRegisterReadEvent
```
public boolean shouldRegisterReadEvent()
```
    Description copied from interface: Connection
    
    Used to determine if the Connection should register with the CorbaTransportManager Selector to handle read events. For example, an HTTP transport would not register since the requesting thread would just block on read when waiting for the reply.
    
    Returns:
    
    true if it should be registered.
  - shouldRegisterServerReadEvent
```
public boolean shouldRegisterServerReadEvent()
```
    Description copied from interface: Connection
    
    Used to determine if the Connection should register with the CorbaTransportManager Selector to handle read events. For example, an HTTP transport would not register since the requesting thread would just block on read when waiting for the reply.
    
    Returns:
    
    true if it should be registered.
  - read
```
public boolean read()
```
    Description copied from interface: Connection
    
    Called to read incoming messages.
    
    Returns:
    
    true if the thread calling read can be released.
  - hasSocketChannel
```
public boolean hasSocketChannel()
```
  - write
```
public void write(ByteBuffer byteBuffer)
           throws IOException
```
    Throws:
    
    IOException
  - close
```
public void close()
```
    Note:it is possible for this to be called more than once
  - closeConnectionResources
```
public void closeConnectionResources()
```
    Description copied from interface: Connection
    
    Clean up all connection resources. Used when shutting down an ORB.
  - closeSocketAndTemporarySelectors
```
protected void closeSocketAndTemporarySelectors()
```
  - getAcceptor
```
public Acceptor getAcceptor()
```
    Specified by:
    
    getAcceptor in interface EventHandler
  - getContactInfo
```
public ContactInfo getContactInfo()
```
  - getEventHandler
```
public EventHandler getEventHandler()
```
  - isServer
```
public boolean isServer()
```
    Description copied from interface: Connection
    
    Indicates whether a CorbaContactInfo or CorbaAcceptor created the Connection.
    
    Returns:
    
    true if a CorbaAcceptor created the Connection.
  - isClosed
```
public boolean isClosed()
```
    Description copied from interface: Connection
    
    Indicates if the Connection is closed.
    
    Returns:
    
    true if the Connection is closed.
  - isBusy
```
public boolean isBusy()
```
    Description copied from interface: Connection
    
    Indicates if the Connection is in the process of sending or receiving a message.
    
    Returns:
    
    true if the Connection is busy.
  - getTimeStamp
```
public long getTimeStamp()
```
    Description copied from interface: Connection
    
    Timestamps are used for connection management, in particular, for reclaiming idle Connections.
    
    Returns:
    
    the "time" the Connection was last used.
  - setTimeStamp
```
public void setTimeStamp(long time)
```
    Description copied from interface: Connection
    
    Timestamps are used for connection management, in particular, for reclaiming idle Connections.
    
    Parameters:
    
    time - - the "time" the Connection was last used.
  - getState
```
protected int getState()
```
  - setState
```
protected void setState(int state)
```
  - setState
```
public void setState(String stateString)
```
    Description copied from interface: Connection
    
    The "state" of the Connection. param state
  - writeLock
```
public void writeLock()
```
    Sets the writeLock for this connection. If the writeLock is already set by someone else, block till the writeLock is released and can set by us. IMPORTANT: this connection's lock must be acquired before setting the writeLock and must be unlocked after setting the writeLock.
  - writeUnlock
```
public void writeUnlock()
```
    Description copied from interface: Connection
    
    Release a write lock on the Connection.
  - sendWithoutLock
```
public void sendWithoutLock(CDROutputObject outputObject)
```
  - registerWaiter
```
public void registerWaiter(MessageMediator messageMediator)
```
    Description copied from interface: Connection
    
    Register an invocation's CorbaMessageMediator with the Connection. This is useful in protocols which support fragmentation.
  - unregisterWaiter
```
public void unregisterWaiter(MessageMediator messageMediator)
```
    Description copied from interface: Connection
    
    Unregister an invocation's * CorbaMessageMediator with the Connection.
  - waitForResponse
```
public CDRInputObject waitForResponse(MessageMediator messageMediator)
```
    Description copied from interface: Connection
    
    If a message expect's a response then this method is called. This method might block on a read (e.g., HTTP), put the calling thread to sleep while another thread read's the response (e.g., GIOP), or it may use the calling thread to perform the server-side work (e.g., Solaris Doors).
  - setConnectionCache
```
public void setConnectionCache(ConnectionCache connectionCache)
```
  - getConnectionCache
```
public ConnectionCache getConnectionCache()
```
  - setUseSelectThreadToWait
```
public void setUseSelectThreadToWait(boolean x)
```
    Specified by:
    
    setUseSelectThreadToWait in interface EventHandler
    
    Overrides:
    
    setUseSelectThreadToWait in class EventHandlerBase
  - getChannel
```
public SelectableChannel getChannel()
```
    Specified by:
    
    getChannel in interface EventHandler
  - getInterestOps
```
public int getInterestOps()
```
    Specified by:
    
    getInterestOps in interface EventHandler
  - getConnection
```
public Connection getConnection()
```
    Specified by:
    
    getConnection in interface EventHandler
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface Work
  - doWork
```
public void doWork()
```
    Specified by:
    
    doWork in interface Work
  - setEnqueueTime
```
public void setEnqueueTime(long timeInMillis)
```
    Specified by:
    
    setEnqueueTime in interface Work
  - getEnqueueTime
```
public long getEnqueueTime()
```
    Specified by:
    
    getEnqueueTime in interface Work
  - getResponseWaitingRoom
```
public ResponseWaitingRoom getResponseWaitingRoom()
```
  - serverRequestMapPut
```
public void serverRequestMapPut(int reqId,
                                MessageMediator messageMediator)
```
  - serverRequestMapGet
```
public MessageMediator serverRequestMapGet(int reqId)
```
  - serverRequestMapRemove
```
public void serverRequestMapRemove(int reqId)
```
  - getFragmentList
```
public Queue<MessageMediator> getFragmentList(RequestId corbaRequestId)
```
  - removeFragmentList
```
public void removeFragmentList(RequestId corbaRequestId)
```
  - getSocket
```
public Socket getSocket()
```
    Specified by:
    
    getSocket in interface Connection
  - serverRequestProcessingBegins
```
public void serverRequestProcessingBegins()
```
    It is possible for a Close Connection to have been * sent here, but we will not check for this. A "lazy" * Exception will be thrown in the Worker thread after the * incoming request has been processed even though the connection * is closed before the request is processed. This is o.k because * it is a boundary condition. To prevent it we would have to add * more locks which would reduce performance in the normal case.
  - serverRequestProcessingEnds
```
public void serverRequestProcessingEnds()
```
  - getNextRequestId
```
public int getNextRequestId()
```
  - getBroker
```
public ORB getBroker()
```
  - getCodeSetContext
```
public CodeSetComponentInfo.CodeSetContext getCodeSetContext()
```
  - setCodeSetContext
```
public void setCodeSetContext(CodeSetComponentInfo.CodeSetContext csc)
```
  - clientRequestMapGet
```
public MessageMediator clientRequestMapGet(int requestId)
```
  - clientReply_1_1_Put
```
public void clientReply_1_1_Put(MessageMediator x)
```
  - clientReply_1_1_Get
```
public MessageMediator clientReply_1_1_Get()
```
  - clientReply_1_1_Remove
```
public void clientReply_1_1_Remove()
```
  - serverRequest_1_1_Put
```
public void serverRequest_1_1_Put(MessageMediator x)
```
  - serverRequest_1_1_Get
```
public MessageMediator serverRequest_1_1_Get()
```
  - serverRequest_1_1_Remove
```
public void serverRequest_1_1_Remove()
```
  - getStateString
```
protected String getStateString(int state)
```
  - isPostInitialContexts
```
public boolean isPostInitialContexts()
```
  - setPostInitialContexts
```
public void setPostInitialContexts()
```
  - purgeCalls
```
public void purgeCalls(SystemException systemException,
                       boolean die,
                       boolean lockHeld)
```
    Wake up the outstanding requests on the connection, and hand them COMM_FAILURE exception with a given minor code.
    Also, delete connection from connection table and stop the reader thread.
    Note that this should only ever be called by the Reader thread for this connection.
    
    Parameters:
    
    die - Kill the reader thread (this thread) before exiting.
    
    lockHeld - true if the calling thread holds the lock on the connection
  - sendCloseConnection
```
public void sendCloseConnection(GIOPVersion giopVersion)
                         throws IOException
```
    ********************************************************************** The following methods are for dealing with Connection cleaning for better scalability of servers in high network load conditions. ************************************************************************
    
    Throws:
    
    IOException
  - sendMessageError
```
public void sendMessageError(GIOPVersion giopVersion)
                      throws IOException
```
    Throws:
    
    IOException
  - sendCancelRequest
```
public void sendCancelRequest(GIOPVersion giopVersion,
                              int requestId)
                       throws IOException
```
    Send a CancelRequest message. This does not lock the connection, so the caller needs to ensure this method is called appropriately.
    
    Throws:
    
    IOException - - could be due to abortive connection closure.
  - sendHelper
```
protected void sendHelper(GIOPVersion giopVersion,
                          Message msg)
                   throws IOException
```
    Throws:
    
    IOException
  - sendCancelRequestWithLock
```
public void sendCancelRequestWithLock(GIOPVersion giopVersion,
                                      int requestId)
                               throws IOException
```
    Throws:
    
    IOException
  - setCodeBaseIOR
```
public final void setCodeBaseIOR(IOR ior)
```
  - getCodeBaseIOR
```
public final IOR getCodeBaseIOR()
```
  - getCodeBase
```
public final CodeBase getCodeBase()
```
  - setTcpTimeouts
```
protected void setTcpTimeouts(TcpTimeouts tcpTimeouts)
```
  - doOptimizedReadStrategy
```
protected void doOptimizedReadStrategy()
```
  - extractAndProcessMessages
```
public ByteBuffer extractAndProcessMessages(ByteBuffer byteBuffer)
```
  - blockingRead
```
protected void blockingRead()
```
  - nonBlockingRead
```
protected int nonBlockingRead()
```
  - getTemporaryReadSelector
```
protected TemporarySelector getTemporaryReadSelector()
                                              throws IOException
```
    Throws:
    
    IOException
  - closeTemporarySelectors
```
protected void closeTemporarySelectors()
                                throws IOException
```
    Throws:
    
    IOException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ConnectionImpl

Field Summary

Fields inherited from class com.sun.corba.ee.impl.transport.EventHandlerBase

Fields inherited from interface com.sun.corba.ee.spi.transport.Connection

Constructor Summary

Method Summary

Methods inherited from class com.sun.corba.ee.impl.transport.EventHandlerBase

Methods inherited from class java.lang.Object

Field Detail

wrapper

socketChannel

byteBuffer

enqueueTime

contactInfo

acceptor

connectionCache

socket

timeStamp

isServer

requestId

responseWaitingRoom

stateEvent

writeEvent

writeLocked

serverRequestCount

postInitialContexts

codeBaseServerIOR

cachedCodeBase

tcpTimeouts

tmpReadSelector

tmpReadSelectorLock

dispatcher

fragmentMap

codeSetContext

clientReply_1_1

serverRequest_1_1

Constructor Detail

ConnectionImpl

ConnectionImpl

ConnectionImpl

ConnectionImpl

Method Detail

getSocketChannel

defineSocket

shouldRegisterReadEvent

shouldRegisterServerReadEvent

read

hasSocketChannel

write

close

closeConnectionResources

closeSocketAndTemporarySelectors

getAcceptor

getContactInfo

getEventHandler

isServer

isClosed

isBusy

getTimeStamp

setTimeStamp

getState

setState

setState

writeLock

writeUnlock

sendWithoutLock

registerWaiter

unregisterWaiter

waitForResponse

setConnectionCache

getConnectionCache

setUseSelectThreadToWait

getChannel

getInterestOps

getConnection

getName

doWork

setEnqueueTime

getEnqueueTime

getResponseWaitingRoom