weblogic.socket

Class DevPollSocketMuxer

java.lang.Object

weblogic.socket.SocketMuxer

weblogic.socket.ServerSocketMuxer

weblogic.socket.DevPollSocketMuxer

final class DevPollSocketMuxer
extends ServerSocketMuxer

Native implementation for muxing sockets which have data on them. This implementation makes use of the /dev/poll driver for polling. See poll(7) for the man page. The device maintains the poll set at the kernel level. The native code for this muxer exists in native/pollmuxer/DevPollSocketMuxer.c.

Excluded in public API Reference.

Nested Class Summary

Nested classes/interfaces inherited from class weblogic.socket.SocketMuxer

SocketMuxer.SingletonMaker, SocketMuxer.TimerListenerImpl

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	debug
(package private) static byte	FD_ADD
(package private) static byte	FD_REM
private int	maxNumberOfFds
private java.lang.Object	pollLock
private java.lang.Object	pollSetLock
private DevPollSocketInfo[]	sockRecords

Fields inherited from class weblogic.socket.SocketMuxer

DELAYPOLLWAKEUP, rdrThreads, SOCKET_READERS_QUEUE_NAME, sockets

Constructor Summary

Constructors

Constructor and Description
DevPollSocketMuxer()

Method Summary

Modifier and Type	Method and Description
protected void	cancelIo(weblogic.socket.MuxableSocket ms)
(package private) void	cleanupSocket(weblogic.socket.MuxableSocket ms, weblogic.socket.SocketInfo info) Performs cleanup for muxable socket, which is only done once for each muxable socket.
private static int[][]	doPoll() Initiate poll.
(package private) static void	editPollSet(int fd, byte code) Add/Remove interest in a FD.
private static java.lang.String	getBuildTime()
private static int	initDevPoll() Initialize the /dev/poll device.
private static void	p(java.lang.String s)
protected void	processSockets() The main method in the SocketMuxer where the reading occurs.
void	read(java.util.Collection<weblogic.socket.MuxableSocket> muxableSockets)
void	read(weblogic.socket.MuxableSocket ms) Attempts to read data for a MuxableSocket that has been registered.
void	register(java.util.Collection<weblogic.socket.MuxableSocket> muxableSockets)
void	register(weblogic.socket.MuxableSocket ms) Register a MuxableSocket, but do not begin IO.

Methods inherited from class weblogic.socket.ServerSocketMuxer

getMuxer, newSDPServerSocket, newServerSocket

Methods inherited from class weblogic.socket.SocketMuxer

closeSocket, closeSocket, completeIO, createTimeoutTrigger, deliverEndOfStream, deliverHasException, finishExceptionHandling, getNumberOfReaders, getNumSockets, getSockets, getSocketsIterator, handleReadTimeout, initiateIO, initSocket, initSocket, initSocketMuxerOnServer, initSocketReaderThreads, initThreadCount, internalWrite, isAsyncMuxer, isAvailable, newClientSocket, newClientSocket, newClientSocket, newProxySocket, newSDPSocket, newSocket, newSocket, newSocket, newSSLClientSocket, newSSLClientSocket, newSSLClientSocket, newWeblogicSocket, readCompleted, readFromSocket, readReadySocket, reRegister, startSocketReaderThreads, write

Methods inherited from class java.lang.Object

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

Field Detail

sockRecords

private final DevPollSocketInfo[] sockRecords

maxNumberOfFds

private final int maxNumberOfFds

pollLock

private final java.lang.Object pollLock

pollSetLock

private final java.lang.Object pollSetLock

debug

private static final boolean debug

FD_ADD

static final byte FD_ADD

See Also:

Constant Field Values

FD_REM

static final byte FD_REM

See Also:

Constant Field Values

Constructor Detail

DevPollSocketMuxer

public DevPollSocketMuxer()
                   throws java.io.IOException

Throws:

java.io.IOException

Method Detail

register

public void register(weblogic.socket.MuxableSocket ms)
              throws java.io.IOException

Description copied from class: SocketMuxer

Register a MuxableSocket, but do not begin IO. A SocketMuxer implementation should use this opportunity to do any set up it needs to do before a call to read() may be performed. This call is generally called shortly after a new MuxableSocket is created. Calling it with a MuxableSocket which is already registered is an error. Overwritten by NativeSocketMuxer. A CALL TO register() MUST BE FOLLOWED BY A SUBSEQUENT CALL TO read() OR cleanup(). FAILURE TO DO SO WILL LEAD TO THE LEAKING OF FILE HANDLES AND OTHER RESOURCES IN THE SERVER.

Overrides:

register in class SocketMuxer

Throws:

java.io.IOException

See Also:

MuxableSocket

register

public void register(java.util.Collection<weblogic.socket.MuxableSocket> muxableSockets)

Overrides:

register in class SocketMuxer

read

public void read(java.util.Collection<weblogic.socket.MuxableSocket> muxableSockets)

Specified by:

read in class SocketMuxer

read

public void read(weblogic.socket.MuxableSocket ms)

Description copied from class: SocketMuxer

Attempts to read data for a MuxableSocket that has been registered. Calls to read() with a closed socket should be tolerated and silently fail.
The SocketMuxer may use the MuxableSocket getRawSocket() or getSocketInputStream() methods to retrieve the Socket or SocketInputStream underlying the MuxableSocket. Once a read is in progress the SocketMuxer should monitor the MuxableSocket's activity and time it out if it is not used with in the period specified by calling getIdleTimeoutMillis() on the MuxableSocket. If the MuxableSocket is determined to have timed out timeout() should be called on the MuxableSocket.
Data which becomes available should be placed into the byte[] returned from getBuffer() starting at the index returned by getBufferOffest(). After the data is in the byte[] incrementBufferOffset() should be called with the number of bytes read. isMessageComplete() should then be called and if it returns true dispatch() should be called. dispatch() must be called by a ExecuteThread. When the call dispatch() returns no further reading of data should be attempted until read() is called again.
If isMessageComplete() returns false the SocketMuxer should begin monitoring the MuxableSocket to ensure that a complete message is read within the timeout returned by getCompleteMessageTimeoutMillis(). If a complete message is not read within the timeout the SocketMuxer should call hasException() on the MuxableSocket with an IOException.
If at any time the SocketMuxer receives an error while reading data for a MuxableSocket it should call hasException passing in as specific an IOException as possible. This is true even if the error recieved is a MaxMessageSizeExceededException thrown by incrementBufferOffset(). If the socket is reset by its peer the SocketMuxer should throw a SocketResetException().

Specified by:

read in class SocketMuxer

See Also:

ExecuteThread, MuxableSocket, SocketResetException

processSockets

protected void processSockets()

Description copied from class: SocketMuxer

The main method in the SocketMuxer where the reading occurs. If the SocketMuxer requires ExecuteThreads from the main execute queue it should enqueue a SocketReaderRequest for each desired thread using Kernel.execute(). These SocketReaderRequests will call this method which is not expected to return until the thread is no longer needed.
The number of threads concurrently in processSockets() should not exceed the value indicated by KernelMBean.getThreadPoolPercentSocketReaders().

Specified by:

processSockets in class SocketMuxer

See Also:

Kernel, KernelMBean, SocketReaderRequest

cleanupSocket

void cleanupSocket(weblogic.socket.MuxableSocket ms,
                   weblogic.socket.SocketInfo info)

Description copied from class: SocketMuxer

Performs cleanup for muxable socket, which is only done once for each muxable socket.

Overrides:

cleanupSocket in class SocketMuxer

p

private static void p(java.lang.String s)

cancelIo

protected void cancelIo(weblogic.socket.MuxableSocket ms)

Overrides:

cancelIo in class SocketMuxer

initDevPoll

private static int initDevPoll()
                        throws java.io.IOException

Initialize the /dev/poll device. Throws IOException on error. As a side effect, it sets the soft limit equal to the hard limit.

Returns:

the current FD limit

Throws:

java.io.IOException - on error

doPoll

private static int[][] doPoll()
                       throws java.io.IOException

Initiate poll. This operation will not timeout. However it may be interrupted by threads calling editPollSet()

Returns:

An array of FDs and revents which have data/error on them. revents for errors are returned as -ve values

Throws:

java.io.IOException - on error

editPollSet

static void editPollSet(int fd,
                        byte code)
                 throws java.io.IOException

Add/Remove interest in a FD. Valid values for code are FD_ADD | FD_REM

Throws:

java.io.IOException - on error

getBuildTime

private static java.lang.String getBuildTime()

Returns:

the native muxer build/date and time