Package org.apache.tomcat.util.net

Class NioEndpoint.NioSocketWrapper

java.lang.Object

org.apache.tomcat.util.net.SocketWrapperBase<NioChannel>

org.apache.tomcat.util.net.NioEndpoint.NioSocketWrapper

Enclosing class:

NioEndpoint

public static class NioEndpoint.NioSocketWrapper
extends SocketWrapperBase<NioChannel>

NIO socket wrapper that wraps an NioChannel.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.tomcat.util.net.SocketWrapperBase

SocketWrapperBase.BlockingMode, SocketWrapperBase.CompletionCheck, SocketWrapperBase.CompletionHandlerCall, SocketWrapperBase.CompletionState, SocketWrapperBase.OperationState<A>, SocketWrapperBase.VectoredIOCompletionHandler<A>

Field Summary

Fields inherited from class org.apache.tomcat.util.net.SocketWrapperBase

bufferedWriteSize, closed, COMPLETE_READ, COMPLETE_READ_WITH_COMPLETION, COMPLETE_WRITE, COMPLETE_WRITE_WITH_COMPLETION, localAddr, localName, localPort, nonBlockingWriteBuffer, previousIOException, READ_DATA, readOperation, readPending, remoteAddr, remoteHost, remotePort, servletConnection, sm, sniHostName, socketBufferHandler, writeOperation, writePending

Constructor Summary

Constructors

Constructor	Description
NioSocketWrapper(NioChannel channel, NioEndpoint endpoint)	Creates a new NIO socket wrapper.

Method Summary

Modifier and Type	Method	Description
boolean	canWrite()	Checks if the socket write buffer is writable and there is no pending non-blocking write data.
SendfileDataBase	createSendfileData(java.lang.String filename, long pos, long length)	Creates a sendfile data object for the specified file.
void	doClientAuth(SSLSupport sslSupport)	Require the client to perform CLIENT-CERT authentication if it hasn't already done so.
protected void	doClose()	Perform the actual close.
protected void	doWrite(boolean block, java.nio.ByteBuffer buffer)	Write the contents of the ByteBuffer to the socket.
protected boolean	flushNonBlocking()	Flushes remaining buffered data using a non-blocking write.
long	getLastRead()	Returns the last read timestamp.
long	getLastWrite()	Returns the last write timestamp.
NioEndpoint.Poller	getPoller()	Returns the poller.
NioEndpoint.SendfileData	getSendfileData()	Returns the sendfile data.
SSLSupport	getSslSupport()	Obtain an SSLSupport instance for this socket.
boolean	hasDataToWrite()	Checks if there is data waiting to be written to the socket.
int	interestOps()	Returns the current interest operations.
int	interestOps(int ops)	Sets the interest operations.
boolean	interestOpsHas(int targetOp)	Checks if a specific interest operation is set.
boolean	isReadyForRead()	Checks if the socket is ready for reading.
protected <A> SocketWrapperBase.OperationState<A>	newOperationState(boolean read, java.nio.ByteBuffer[] buffers, int offset, int length, SocketWrapperBase.BlockingMode block, long timeout, java.util.concurrent.TimeUnit unit, A attachment, SocketWrapperBase.CompletionCheck check, java.nio.channels.CompletionHandler<java.lang.Long,? super A> handler, java.util.concurrent.Semaphore semaphore, SocketWrapperBase.VectoredIOCompletionHandler<A> completion)	Creates a new operation state for vectored I/O operations.
protected void	populateLocalAddr()	Populates the cached local IP address from the underlying socket.
protected void	populateLocalName()	Populates the cached local host name from the underlying socket.
protected void	populateLocalPort()	Populates the cached local port number from the underlying socket.
protected void	populateRemoteAddr()	Populates the cached remote IP address from the underlying socket.
protected void	populateRemoteHost()	Populates the cached remote host name from the underlying socket.
protected void	populateRemotePort()	Populates the cached remote port number from the underlying socket.
SendfileState	processSendfile(SendfileDataBase sendfileData)	Starts the sendfile process.
int	read(boolean block, byte[] b, int off, int len)	Reads data from the socket into a byte array.
int	read(boolean block, java.nio.ByteBuffer to)	Reads data from the socket into a ByteBuffer.
void	registerReadInterest()	Registers interest in read events.
void	registerWriteInterest()	Registers interest in write events.
void	setAppReadBufHandler(ApplicationBufferHandler handler)	Sets the application-level read buffer handler.
void	setSendfileData(NioEndpoint.SendfileData sf)	Sets the sendfile data.
void	updateLastRead()	Updates the last read timestamp.
void	updateLastWrite()	Updates the last write timestamp.

Methods inherited from class org.apache.tomcat.util.net.SocketWrapperBase

buffersArrayHasRemaining, checkError, close, decrementKeepAlive, doWrite, execute, flush, flushBlocking, getCurrentProcessor, getEndpoint, getError, getLocalAddr, getLocalName, getLocalPort, getLock, getNegotiatedProtocol, getReadTimeout, getRemoteAddr, getRemoteHost, getRemotePort, getServletConnection, getSniHostName, getSocket, getSocketBufferHandler, getWriteTimeout, hasAsyncIO, hasDataToRead, hasPerOperationTimeout, isClosed, isReadPending, isReadyForWrite, isWritePending, needSemaphores, populateReadBuffer, populateReadBuffer, processSocket, read, read, read, reset, setCurrentProcessor, setError, setKeepAliveLeft, setNegotiatedProtocol, setReadTimeout, setSniHostName, setWriteTimeout, takeCurrentProcessor, toString, transfer, transfer, unRead, vectoredOperation, write, write, write, write, write, writeBlocking, writeBlocking, writeNonBlocking, writeNonBlocking, writeNonBlockingInternal

Methods inherited from class java.lang.Object

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

Constructor Detail

NioSocketWrapper

public NioSocketWrapper(NioChannel channel,
                        NioEndpoint endpoint)

Creates a new NIO socket wrapper.

Parameters:

channel - The NIO channel

endpoint - The NIO endpoint

Method Detail

getPoller

public NioEndpoint.Poller getPoller()

Returns the poller.

Returns:

the poller

interestOps

public int interestOps()

Returns the current interest operations.

Returns:

the interest operations

interestOps

public int interestOps(int ops)

Sets the interest operations.

Parameters:

ops - the interest operations

Returns:

the interest operations

interestOpsHas

public boolean interestOpsHas(int targetOp)

Checks if a specific interest operation is set.

Parameters:

targetOp - the operation to check

Returns:

true if the target operation is set

setSendfileData

public void setSendfileData(NioEndpoint.SendfileData sf)

Sets the sendfile data.

Parameters:

sf - the sendfile data

getSendfileData

public NioEndpoint.SendfileData getSendfileData()

Returns the sendfile data.

Returns:

the sendfile data

updateLastWrite

public void updateLastWrite()

Updates the last write timestamp.

getLastWrite

public long getLastWrite()

Returns the last write timestamp.

Returns:

the last write time in milliseconds

updateLastRead

public void updateLastRead()

Updates the last read timestamp.

getLastRead

public long getLastRead()

Returns the last read timestamp.

Returns:

the last read time in milliseconds

isReadyForRead

public boolean isReadyForRead()
                       throws java.io.IOException

Description copied from class: SocketWrapperBase

Checks if the socket is ready for reading.

Specified by:

isReadyForRead in class SocketWrapperBase<NioChannel>

Returns:

true if data is available to read

Throws:

java.io.IOException - If an I/O error occurs

read

public int read(boolean block,
                byte[] b,
                int off,
                int len)
         throws java.io.IOException

Description copied from class: SocketWrapperBase

Reads data from the socket into a byte array.

Specified by:

read in class SocketWrapperBase<NioChannel>

Parameters:

block - Whether to block

b - The byte array to read into

off - The offset in the array

len - The number of bytes to read

Returns:

the number of bytes read

Throws:

java.io.IOException - If an I/O error occurs

read

public int read(boolean block,
                java.nio.ByteBuffer to)
         throws java.io.IOException

Description copied from class: SocketWrapperBase

Reads data from the socket into a ByteBuffer.

Specified by:

read in class SocketWrapperBase<NioChannel>

Parameters:

block - Whether to block

to - The ByteBuffer to read into

Returns:

the number of bytes read

Throws:

java.io.IOException - If an I/O error occurs

doClose

protected void doClose()

Description copied from class: SocketWrapperBase

Perform the actual close. The closed atomic boolean guarantees this will be called only once per wrapper.

Specified by:

doClose in class SocketWrapperBase<NioChannel>

flushNonBlocking

protected boolean flushNonBlocking()
                            throws java.io.IOException

Description copied from class: SocketWrapperBase

Flushes remaining buffered data using a non-blocking write.

Specified by:

flushNonBlocking in class SocketWrapperBase<NioChannel>

Returns:

true if data remains to be flushed after this method completes, otherwise false

Throws:

java.io.IOException - If an IO error occurs during the write

hasDataToWrite

public boolean hasDataToWrite()

Description copied from class: SocketWrapperBase

Checks if there is data waiting to be written to the socket.

Overrides:

hasDataToWrite in class SocketWrapperBase<NioChannel>

Returns:

true if there is pending write data

canWrite

public boolean canWrite()

Description copied from class: SocketWrapperBase

Checks if the socket write buffer is writable and there is no pending non-blocking write data.

Overrides:

canWrite in class SocketWrapperBase<NioChannel>

Returns:

true if the socket is ready for writing

doWrite

protected void doWrite(boolean block,
                       java.nio.ByteBuffer buffer)
                throws java.io.IOException

Description copied from class: SocketWrapperBase

Write the contents of the ByteBuffer to the socket. For blocking writes either then entire contents of the buffer will be written or an IOException will be thrown. Partial blocking writes will not occur.

Specified by:

doWrite in class SocketWrapperBase<NioChannel>

Parameters:

block - Should the write be blocking or not?

buffer - the ByteBuffer containing the data to be written

Throws:

java.io.IOException - If an I/O error such as a timeout occurs during the write

registerReadInterest

public void registerReadInterest()

Description copied from class: SocketWrapperBase

Registers interest in read events.

Specified by:

registerReadInterest in class SocketWrapperBase<NioChannel>

registerWriteInterest

public void registerWriteInterest()

Description copied from class: SocketWrapperBase

Registers interest in write events.

Specified by:

registerWriteInterest in class SocketWrapperBase<NioChannel>

createSendfileData

public SendfileDataBase createSendfileData(java.lang.String filename,
                                           long pos,
                                           long length)

Description copied from class: SocketWrapperBase

Creates a sendfile data object for the specified file.

Specified by:

createSendfileData in class SocketWrapperBase<NioChannel>

Parameters:

filename - The file to send

pos - The starting position in the file

length - The number of bytes to send

Returns:

a new sendfile data object

processSendfile

public SendfileState processSendfile(SendfileDataBase sendfileData)

Description copied from class: SocketWrapperBase

Starts the sendfile process. It is expected that if the sendfile process does not complete during this call and does not report an error, that the caller will not add the socket to the poller (or equivalent). That is the responsibility of this method.

Specified by:

processSendfile in class SocketWrapperBase<NioChannel>

Parameters:

sendfileData - Data representing the file to send

Returns:

The state of the sendfile process after the first write.

populateRemoteAddr

protected void populateRemoteAddr()

Description copied from class: SocketWrapperBase

Populates the cached remote IP address from the underlying socket.

Specified by:

populateRemoteAddr in class SocketWrapperBase<NioChannel>

populateRemoteHost

protected void populateRemoteHost()

Description copied from class: SocketWrapperBase

Populates the cached remote host name from the underlying socket.

Specified by:

populateRemoteHost in class SocketWrapperBase<NioChannel>

populateRemotePort

protected void populateRemotePort()

Description copied from class: SocketWrapperBase

Populates the cached remote port number from the underlying socket.

Specified by:

populateRemotePort in class SocketWrapperBase<NioChannel>

populateLocalName

protected void populateLocalName()

Description copied from class: SocketWrapperBase

Populates the cached local host name from the underlying socket.

Specified by:

populateLocalName in class SocketWrapperBase<NioChannel>

populateLocalAddr

protected void populateLocalAddr()

Description copied from class: SocketWrapperBase

Populates the cached local IP address from the underlying socket.

Specified by:

populateLocalAddr in class SocketWrapperBase<NioChannel>

populateLocalPort

protected void populateLocalPort()

Description copied from class: SocketWrapperBase

Populates the cached local port number from the underlying socket.

Specified by:

populateLocalPort in class SocketWrapperBase<NioChannel>

getSslSupport

public SSLSupport getSslSupport()

Description copied from class: SocketWrapperBase

Obtain an SSLSupport instance for this socket.

Specified by:

getSslSupport in class SocketWrapperBase<NioChannel>

Returns:

An SSLSupport instance for this socket.

doClientAuth

public void doClientAuth(SSLSupport sslSupport)
                  throws java.io.IOException

Description copied from class: SocketWrapperBase

Require the client to perform CLIENT-CERT authentication if it hasn't already done so.

Specified by:

doClientAuth in class SocketWrapperBase<NioChannel>

Parameters:

sslSupport - The SSL/TLS support instance currently being used by the connection that may need updating after the client authentication

Throws:

java.io.IOException - If authentication is required then there will be I/O with the client and this exception will be thrown if that goes wrong

setAppReadBufHandler

public void setAppReadBufHandler(ApplicationBufferHandler handler)

Description copied from class: SocketWrapperBase

Sets the application-level read buffer handler.

Specified by:

setAppReadBufHandler in class SocketWrapperBase<NioChannel>

Parameters:

handler - The application buffer handler

newOperationState

protected <A> SocketWrapperBase.OperationState<A> newOperationState(boolean read,
                                                                    java.nio.ByteBuffer[] buffers,
                                                                    int offset,
                                                                    int length,
                                                                    SocketWrapperBase.BlockingMode block,
                                                                    long timeout,
                                                                    java.util.concurrent.TimeUnit unit,
                                                                    A attachment,
                                                                    SocketWrapperBase.CompletionCheck check,
                                                                    java.nio.channels.CompletionHandler<java.lang.Long,? super A> handler,
                                                                    java.util.concurrent.Semaphore semaphore,
                                                                    SocketWrapperBase.VectoredIOCompletionHandler<A> completion)

Description copied from class: SocketWrapperBase

Creates a new operation state for vectored I/O operations.

Specified by:

newOperationState in class SocketWrapperBase<NioChannel>

Type Parameters:

A - The attachment type

Parameters:

read - Whether this is a read operation

buffers - The buffers for the operation

offset - The offset in the buffer array

length - The number of buffers

block - The blocking mode

timeout - The timeout duration

unit - The timeout time unit

attachment - An attachment object

check - The completion check

handler - The completion handler

semaphore - The semaphore for synchronization

completion - The vectored I/O completion handler

Returns:

a new operation state instance