Package com.sun.corba.se.impl.transport

Class SocketOrChannelConnectionImpl

java.lang.Object

com.sun.corba.se.impl.transport.EventHandlerBase

com.sun.corba.se.impl.transport.SocketOrChannelConnectionImpl

All Implemented Interfaces:

Connection, EventHandler, Connection, Work, CorbaConnection

Direct Known Subclasses:

SocketFactoryConnectionImpl

public class SocketOrChannelConnectionImpl
extends EventHandlerBase
implements CorbaConnection, Work

Author:

Harold Carr

Field Summary

Fields

Modifier and Type	Field	Description
protected Acceptor	acceptor
protected CachedCodeBase	cachedCodeBase
protected MessageMediator	clientReply_1_1
protected IOR	codeBaseServerIOR
protected CodeSetComponentInfo.CodeSetContext	codeSetContext
protected ConnectionCache	connectionCache
protected CorbaContactInfo	contactInfo
static boolean	dprintWriteLocks
protected long	enqueueTime
protected boolean	isServer
protected CorbaMessageMediator	partialMessageMediator
protected boolean	postInitialContexts
protected ReadTimeouts	readTimeouts
protected int	requestId
protected CorbaResponseWaitingRoom	responseWaitingRoom
protected MessageMediator	serverRequest_1_1
protected int	serverRequestCount
protected boolean	shouldReadGiopHeaderOnly
protected Socket	socket
protected SocketChannel	socketChannel
protected int	state
protected Object	stateEvent
protected long	timeStamp
protected ORBUtilSystemException	wrapper
protected Object	writeEvent
protected boolean	writeLocked

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

orb, selectionKey, useSelectThreadToWait, useWorkerThreadForEvent, work

Fields inherited from interface com.sun.corba.se.spi.transport.CorbaConnection

ABORT, CLOSE_RECVD, CLOSE_SENT, ESTABLISHED, OPENING

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SocketOrChannelConnectionImpl(ORB orb)
protected	SocketOrChannelConnectionImpl(ORB orb, boolean useSelectThreadToWait, boolean useWorkerThread)
	SocketOrChannelConnectionImpl(ORB orb, Acceptor acceptor, Socket socket)
	SocketOrChannelConnectionImpl(ORB orb, Acceptor acceptor, Socket socket, boolean useSelectThreadToWait, boolean useWorkerThread)
	SocketOrChannelConnectionImpl(ORB orb, CorbaContactInfo contactInfo, boolean useSelectThreadToWait, boolean useWorkerThread, String socketType, String hostname, int port)
	SocketOrChannelConnectionImpl(ORB orb, CorbaContactInfo contactInfo, String socketType, String hostname, int port)

Method Summary

Modifier and Type	Method	Description
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.
OutputObject	createOutputObject(MessageMediator messageMediator)
protected boolean	dispatch(CorbaMessageMediator messageMediator)
void	doWork()	This method denotes the actual work that is done by the work item.
void	dprint(String msg)
protected void	dprint(String msg, Throwable t)
protected CorbaMessageMediator	finishReadingBits(MessageMediator messageMediator)
Acceptor	getAcceptor()	Get the Acceptor that created this Connection.
ORB	getBroker()
SelectableChannel	getChannel()
final CodeBase	getCodeBase()
final IOR	getCodeBaseIOR()
CodeSetComponentInfo.CodeSetContext	getCodeSetContext()
Connection	getConnection()
ConnectionCache	getConnectionCache()
ContactInfo	getContactInfo()	Get the ContactInfo that created this Connection.
long	getEnqueueTime()	This methods gets the time in millis in the work item, when this work item was enqueued in the work queue.
EventHandler	getEventHandler()	Get the EventHandler associated with this Acceptor.
int	getInterestOps()
String	getName()	This method will return the name of the work item.
int	getNextRequestId()
protected CorbaMessageMediator	getPartialMessageMediator()
ResponseWaitingRoom	getResponseWaitingRoom()
Socket	getSocket()
SocketChannel	getSocketChannel()
protected String	getStateString(int state)
long	getTimeStamp()	Timestamps are used for connection management, in particular, for reclaiming idle Connections.
void	handleEvent()
boolean	isBusy()	Indicates if the Connection is in the process of sending or receiving a message.
boolean	isPostInitialContexts()
boolean	isServer()	Indicates whether a ContactInfo or a Acceptor created the Connection.
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.
ByteBuffer	read(int size, int offset, int length, long max_wait_time)
ByteBuffer	read(ByteBuffer byteBuffer, int offset, int length, long max_wait_time)
protected CorbaMessageMediator	readBits()
void	readFully(InputStream is, byte[] buf, int offset, int size, long max_wait_time)
void	readFully(ByteBuffer byteBuffer, int size, long max_wait_time)
void	registerWaiter(MessageMediator messageMediator)	Register an invocation's MessageMediator with the Connection.
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(OutputObject outputObject)
MessageMediator	serverRequest_1_1_Get()
void	serverRequest_1_1_Put(MessageMediator x)
void	serverRequest_1_1_Remove()
CorbaMessageMediator	serverRequestMapGet(int requestId)
void	serverRequestMapPut(int requestId, CorbaMessageMediator messageMediator)
void	serverRequestMapRemove(int requestId)
void	serverRequestProcessingBegins()	It is possible for a Close Connection to have been sent here, but we will not check for this.
void	serverRequestProcessingEnds()
final void	setCodeBaseIOR(IOR ior)
void	setCodeSetContext(CodeSetComponentInfo.CodeSetContext csc)
void	setConnectionCache(ConnectionCache connectionCache)
void	setEnqueueTime(long timeInMillis)	This methods sets the time in millis in the work item, when this work item was enqueued in the work queue.
protected void	setPartialMessageMediator(CorbaMessageMediator messageMediator)
void	setPostInitialContexts()
protected void	setReadGiopHeaderOnly(boolean shouldReadHeaderOnly)
protected void	setReadTimeouts(ReadTimeouts readTimeouts)
void	setState(String stateString)	The "state" of the Connection.
void	setTimeStamp(long time)	Timestamps are used for connection management, in particular, for reclaiming idle Connections.
void	setUseSelectThreadToWait(boolean x)
boolean	shouldReadGiopHeaderOnly()
boolean	shouldRegisterReadEvent()	Used to determine if the Connection should register with the TransportManager Selector to handle read events.
boolean	shouldRegisterServerReadEvent()	Used to determine if the Connection should register with the TransportManager Selector to handle read events.
boolean	shouldUseDirectByteBuffers()
String	toString()
void	unregisterWaiter(MessageMediator messageMediator)	Unregister an invocation's MessageMediator with the Connection.
InputObject	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.se.impl.transport.EventHandlerBase

getSelectionKey, getWork, setSelectionKey, setUseWorkerThreadForEvent, setWork, shouldUseSelectThreadToWait, shouldUseWorkerThreadForEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

dprintWriteLocks

public static boolean dprintWriteLocks

enqueueTime

protected long enqueueTime

socketChannel

protected SocketChannel socketChannel

contactInfo

protected CorbaContactInfo contactInfo

acceptor

protected Acceptor acceptor

connectionCache

protected ConnectionCache connectionCache

socket

protected Socket socket

timeStamp

protected long timeStamp

isServer

protected boolean isServer

requestId

protected int requestId

responseWaitingRoom

protected CorbaResponseWaitingRoom responseWaitingRoom

state

protected int state

stateEvent

protected Object stateEvent

writeEvent

protected Object writeEvent

writeLocked

protected boolean writeLocked

serverRequestCount

protected int serverRequestCount

postInitialContexts

protected boolean postInitialContexts

codeBaseServerIOR

protected IOR codeBaseServerIOR

cachedCodeBase

protected CachedCodeBase cachedCodeBase

wrapper

protected ORBUtilSystemException wrapper

readTimeouts

protected ReadTimeouts readTimeouts

shouldReadGiopHeaderOnly

protected boolean shouldReadGiopHeaderOnly

partialMessageMediator

protected CorbaMessageMediator partialMessageMediator

codeSetContext

protected CodeSetComponentInfo.CodeSetContext codeSetContext

clientReply_1_1

protected MessageMediator clientReply_1_1

serverRequest_1_1

protected MessageMediator serverRequest_1_1

Constructor Details

SocketOrChannelConnectionImpl

protected SocketOrChannelConnectionImpl(ORB orb)

SocketOrChannelConnectionImpl

protected SocketOrChannelConnectionImpl(ORB orb,
 boolean useSelectThreadToWait,
 boolean useWorkerThread)

SocketOrChannelConnectionImpl

public SocketOrChannelConnectionImpl(ORB orb,
 CorbaContactInfo contactInfo,
 boolean useSelectThreadToWait,
 boolean useWorkerThread,
 String socketType,
 String hostname,
 int port)

SocketOrChannelConnectionImpl

public SocketOrChannelConnectionImpl(ORB orb,
 CorbaContactInfo contactInfo,
 String socketType,
 String hostname,
 int port)

SocketOrChannelConnectionImpl

public SocketOrChannelConnectionImpl(ORB orb,
 Acceptor acceptor,
 Socket socket,
 boolean useSelectThreadToWait,
 boolean useWorkerThread)

SocketOrChannelConnectionImpl

public SocketOrChannelConnectionImpl(ORB orb,
 Acceptor acceptor,
 Socket socket)

Method Details

getSocketChannel

public SocketChannel getSocketChannel()

Specified by:

getSocketChannel in interface CorbaConnection

shouldRegisterReadEvent

public boolean shouldRegisterReadEvent()

Description copied from interface: Connection

Used to determine if the Connection should register with the TransportManager 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.

Specified by:

shouldRegisterReadEvent in interface Connection

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 TransportManager 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.

Specified by:

shouldRegisterServerReadEvent in interface Connection

Returns:

true if it should be registered.

read

public boolean read()

Description copied from interface: Connection

Called to read incoming messages.

Specified by:

read in interface Connection

Returns:

true if the thread calling read can be released.

readBits

protected CorbaMessageMediator readBits()

finishReadingBits

protected CorbaMessageMediator finishReadingBits(MessageMediator messageMediator)

dispatch

protected boolean dispatch(CorbaMessageMediator messageMediator)

shouldUseDirectByteBuffers

public boolean shouldUseDirectByteBuffers()

Specified by:

shouldUseDirectByteBuffers in interface CorbaConnection

read

public ByteBuffer read(int size,
 int offset,
 int length,
 long max_wait_time)
                throws IOException

Specified by:

read in interface CorbaConnection

Throws:

IOException

read

public ByteBuffer read(ByteBuffer byteBuffer,
 int offset,
 int length,
 long max_wait_time)
                throws IOException

Specified by:

read in interface CorbaConnection

Throws:

IOException

readFully

public void readFully(ByteBuffer byteBuffer,
 int size,
 long max_wait_time)
               throws IOException

Throws:

IOException

readFully

public void readFully(InputStream is,
 byte[] buf,
 int offset,
 int size,
 long max_wait_time)
               throws IOException

Throws:

IOException

write

public void write(ByteBuffer byteBuffer)
           throws IOException

Specified by:

write in interface CorbaConnection

Throws:

IOException

close

public void close()

Note:it is possible for this to be called more than once

Specified by:

close in interface Connection

closeConnectionResources

public void closeConnectionResources()

Description copied from interface: CorbaConnection

Clean up all connection resources. Used when shutting down an ORB.

Specified by:

closeConnectionResources in interface CorbaConnection

getAcceptor

public Acceptor getAcceptor()

Description copied from interface: Connection

Get the Acceptor that created this Connection.

Specified by:

getAcceptor in interface Connection

Specified by:

getAcceptor in interface EventHandler

Returns:

Acceptor

getContactInfo

public ContactInfo getContactInfo()

Description copied from interface: Connection

Get the ContactInfo that created this Connection.

Specified by:

getContactInfo in interface Connection

Returns:

ContactInfo

getEventHandler

public EventHandler getEventHandler()

Description copied from interface: Connection

Get the EventHandler associated with this Acceptor.

Specified by:

getEventHandler in interface Connection

Returns:

EventHandler

createOutputObject

public OutputObject createOutputObject(MessageMediator messageMediator)

isServer

public boolean isServer()

Description copied from interface: Connection

Indicates whether a ContactInfo or a Acceptor created the Connection.

Specified by:

isServer in interface Connection

Returns:

true if Connection an Acceptor created the Connection.

isBusy

public boolean isBusy()

Description copied from interface: Connection

Indicates if the Connection is in the process of sending or receiving a message.

Specified by:

isBusy in interface Connection

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.

Specified by:

getTimeStamp in interface Connection

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.

Specified by:

setTimeStamp in interface Connection

Parameters:

time - - the "time" the Connection was last used.

setState

public void setState(String stateString)

Description copied from interface: Connection

The "state" of the Connection. param state

Specified by:

setState in interface Connection

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.

Specified by:

writeLock in interface Connection

writeUnlock

public void writeUnlock()

Description copied from interface: Connection

Release a write lock on the Connection.

Specified by:

writeUnlock in interface Connection

sendWithoutLock

public void sendWithoutLock(OutputObject outputObject)

Specified by:

sendWithoutLock in interface Connection

registerWaiter

public void registerWaiter(MessageMediator messageMediator)

Description copied from interface: Connection

Register an invocation's MessageMediator with the Connection. This is useful in protocols which support fragmentation.

Specified by:

registerWaiter in interface Connection

unregisterWaiter

public void unregisterWaiter(MessageMediator messageMediator)

Description copied from interface: Connection

Unregister an invocation's MessageMediator with the Connection.

Specified by:

unregisterWaiter in interface Connection

waitForResponse

public InputObject 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).

Specified by:

waitForResponse in interface Connection

setConnectionCache

public void setConnectionCache(ConnectionCache connectionCache)

Specified by:

setConnectionCache in interface Connection

getConnectionCache

public ConnectionCache getConnectionCache()

Specified by:

getConnectionCache in interface Connection

setUseSelectThreadToWait

public void setUseSelectThreadToWait(boolean x)

Specified by:

setUseSelectThreadToWait in interface EventHandler

Overrides:

setUseSelectThreadToWait in class EventHandlerBase

handleEvent

public void handleEvent()

Specified by:

handleEvent in interface EventHandler

Overrides:

handleEvent 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()

Description copied from interface: Work

This method will return the name of the work item.

Specified by:

getName in interface Work

doWork

public void doWork()

Description copied from interface: Work

This method denotes the actual work that is done by the work item.

Specified by:

doWork in interface Work

setEnqueueTime

public void setEnqueueTime(long timeInMillis)

Description copied from interface: Work

This methods sets the time in millis in the work item, when this work item was enqueued in the work queue.

Specified by:

setEnqueueTime in interface Work

getEnqueueTime

public long getEnqueueTime()

Description copied from interface: Work

This methods gets the time in millis in the work item, when this work item was enqueued in the work queue.

Specified by:

getEnqueueTime in interface Work

shouldReadGiopHeaderOnly

public boolean shouldReadGiopHeaderOnly()

Specified by:

shouldReadGiopHeaderOnly in interface CorbaConnection

setReadGiopHeaderOnly

protected void setReadGiopHeaderOnly(boolean shouldReadHeaderOnly)

getResponseWaitingRoom

public ResponseWaitingRoom getResponseWaitingRoom()

Specified by:

getResponseWaitingRoom in interface CorbaConnection

serverRequestMapPut

public void serverRequestMapPut(int requestId,
 CorbaMessageMediator messageMediator)

Specified by:

serverRequestMapPut in interface CorbaConnection

serverRequestMapGet

public CorbaMessageMediator serverRequestMapGet(int requestId)

Specified by:

serverRequestMapGet in interface CorbaConnection

serverRequestMapRemove

public void serverRequestMapRemove(int requestId)

Specified by:

serverRequestMapRemove in interface CorbaConnection

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.

Specified by:

serverRequestProcessingBegins in interface CorbaConnection

serverRequestProcessingEnds

public void serverRequestProcessingEnds()

Specified by:

serverRequestProcessingEnds in interface CorbaConnection

getNextRequestId

public int getNextRequestId()

Specified by:

getNextRequestId in interface CorbaConnection

getBroker

public ORB getBroker()

Specified by:

getBroker in interface CorbaConnection

getCodeSetContext

public CodeSetComponentInfo.CodeSetContext getCodeSetContext()

Specified by:

getCodeSetContext in interface CorbaConnection

setCodeSetContext

public void setCodeSetContext(CodeSetComponentInfo.CodeSetContext csc)

Specified by:

setCodeSetContext in interface CorbaConnection

clientRequestMapGet

public MessageMediator clientRequestMapGet(int requestId)

Specified by:

clientRequestMapGet in interface CorbaConnection

clientReply_1_1_Put

public void clientReply_1_1_Put(MessageMediator x)

Specified by:

clientReply_1_1_Put in interface CorbaConnection

clientReply_1_1_Get

public MessageMediator clientReply_1_1_Get()

Specified by:

clientReply_1_1_Get in interface CorbaConnection

clientReply_1_1_Remove

public void clientReply_1_1_Remove()

Specified by:

clientReply_1_1_Remove in interface CorbaConnection

serverRequest_1_1_Put

public void serverRequest_1_1_Put(MessageMediator x)

Specified by:

serverRequest_1_1_Put in interface CorbaConnection

serverRequest_1_1_Get

public MessageMediator serverRequest_1_1_Get()

Specified by:

serverRequest_1_1_Get in interface CorbaConnection

serverRequest_1_1_Remove

public void serverRequest_1_1_Remove()

Specified by:

serverRequest_1_1_Remove in interface CorbaConnection

getStateString

protected String getStateString(int state)

isPostInitialContexts

public boolean isPostInitialContexts()

Specified by:

isPostInitialContexts in interface CorbaConnection

setPostInitialContexts

public void setPostInitialContexts()

Specified by:

setPostInitialContexts in interface CorbaConnection

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.

Specified by:

purgeCalls in interface CorbaConnection

Parameters:

minor_code - The minor code for the COMM_FAILURE major code.

die - Kill the reader thread (this thread) before exiting.

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.

Specified by:

sendCloseConnection in interface CorbaConnection

Throws:

IOException

sendMessageError

public void sendMessageError(GIOPVersion giopVersion)
                      throws IOException

Specified by:

sendMessageError in interface CorbaConnection

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.

Specified by:

sendCancelRequest in interface CorbaConnection

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

Specified by:

sendCancelRequestWithLock in interface CorbaConnection

Throws:

IOException

setCodeBaseIOR

public final void setCodeBaseIOR(IOR ior)

Specified by:

setCodeBaseIOR in interface CorbaConnection

getCodeBaseIOR

public final IOR getCodeBaseIOR()

Specified by:

getCodeBaseIOR in interface CorbaConnection

getCodeBase

public final CodeBase getCodeBase()

Specified by:

getCodeBase in interface CorbaConnection

setReadTimeouts

protected void setReadTimeouts(ReadTimeouts readTimeouts)

setPartialMessageMediator

protected void setPartialMessageMediator(CorbaMessageMediator messageMediator)

getPartialMessageMediator

protected CorbaMessageMediator getPartialMessageMediator()

toString

public String toString()

Overrides:

toString in class Object

dprint

public void dprint(String msg)

Specified by:

dprint in interface CorbaConnection

dprint

protected void dprint(String msg,
 Throwable t)