Class Nio2Endpoint.Nio2SocketWrapper
- Enclosing class:
- Nio2Endpoint
- 
Nested Class SummaryNested classes/interfaces inherited from class org.apache.tomcat.util.net.SocketWrapperBaseSocketWrapperBase.BlockingMode, SocketWrapperBase.CompletionCheck, SocketWrapperBase.CompletionHandlerCall, SocketWrapperBase.CompletionState, SocketWrapperBase.OperationState<A>, SocketWrapperBase.VectoredIOCompletionHandler<A>
- 
Field SummaryFields inherited from class org.apache.tomcat.util.net.SocketWrapperBasebufferedWriteSize, 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, socketBufferHandler, writeOperation, writePending
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptioncreateSendfileData(String filename, long pos, long length) voiddoClientAuth(SSLSupport sslSupport) Require the client to perform CLIENT-CERT authentication if it hasn't already done so.protected voiddoClose()Perform the actual close.protected voiddoWrite(boolean block, ByteBuffer from) Write the contents of the ByteBuffer to the socket.protected voidWrites all remaining data from the buffers and blocks until the write is complete.protected booleanWrites as much data as possible from any that remains in the buffers.Obtain an SSLSupport instance for this socket.booleanAllows using NIO2 style read/write.booleanbooleanbooleanAllows indicating if the connector supports per operation timeout.booleanAllows checking if an asynchronous read operation is currently pending.booleanbooleanChecks to see if there are any writes pending and if there are callsSocketWrapperBase.registerWriteInterest()to trigger a callback once the pending writes have completed.booleanAllows checking if an asynchronous write operation is currently pending.booleanAllows indicating if the connector needs semaphores.protected <A> SocketWrapperBase<Nio2Channel>.OperationState<A>newOperationState(boolean read, ByteBuffer[] buffers, int offset, int length, SocketWrapperBase.BlockingMode block, long timeout, TimeUnit unit, A attachment, SocketWrapperBase.CompletionCheck check, CompletionHandler<Long, ? super A> handler, Semaphore semaphore, SocketWrapperBase<Nio2Channel>.VectoredIOCompletionHandler<A> completion) protected voidprotected voidprotected voidprotected voidprotected voidprotected voidprocessSendfile(SendfileDataBase sendfileData) Starts the sendfile process.intread(boolean block, byte[] b, int off, int len) intread(boolean block, ByteBuffer to) voidvoidvoidvoidprotected voidwriteNonBlocking(byte[] buf, int off, int len) Transfers the data to the socket write buffer (writing that data to the socket if the buffer fills up using a non-blocking write) until either all the data has been transferred and space remains in the socket write buffer or a non-blocking write leaves data in the socket write buffer.protected voidwriteNonBlocking(ByteBuffer from) Transfers the data to the socket write buffer (writing that data to the socket if the buffer fills up using a non-blocking write) until either all the data has been transferred and space remains in the socket write buffer or a non-blocking write leaves data in the socket write buffer.protected voidSeparate method so it can be re-used by the socket write buffer to write data to the networkMethods inherited from class org.apache.tomcat.util.net.SocketWrapperBasebuffersArrayHasRemaining, canWrite, checkError, close, decrementKeepAlive, doWrite, execute, flush, getCurrentProcessor, getEndpoint, getError, getLocalAddr, getLocalName, getLocalPort, getLock, getNegotiatedProtocol, getReadTimeout, getRemoteAddr, getRemoteHost, getRemotePort, getServletConnection, getSocket, getSocketBufferHandler, getWriteTimeout, isClosed, populateReadBuffer, populateReadBuffer, processSocket, read, read, read, reset, setCurrentProcessor, setError, setKeepAliveLeft, setNegotiatedProtocol, setReadTimeout, setWriteTimeout, takeCurrentProcessor, toString, transfer, transfer, unRead, vectoredOperation, write, write, write, write, write, writeBlocking, writeBlocking
- 
Constructor Details- 
Nio2SocketWrapper
 
- 
- 
Method Details- 
setSendfileData
- 
getSendfileData
- 
isReadyForRead- Specified by:
- isReadyForReadin class- SocketWrapperBase<Nio2Channel>
- Throws:
- IOException
 
- 
isReadyForWritepublic boolean isReadyForWrite()Description copied from class:SocketWrapperBaseChecks to see if there are any writes pending and if there are callsSocketWrapperBase.registerWriteInterest()to trigger a callback once the pending writes have completed.Note: Once this method has returned falseit MUST NOT be called again until the pending write has completed and the callback has been fired. TODO: ModifySocketWrapperBase.registerWriteInterest()so the above restriction is enforced there rather than relying on the caller.- Overrides:
- isReadyForWritein class- SocketWrapperBase<Nio2Channel>
- Returns:
- trueif no writes are pending and data can be written otherwise- false
 
- 
read- Specified by:
- readin class- SocketWrapperBase<Nio2Channel>
- Throws:
- IOException
 
- 
read- Specified by:
- readin class- SocketWrapperBase<Nio2Channel>
- Throws:
- IOException
 
- 
doCloseprotected void doClose()Description copied from class:SocketWrapperBasePerform the actual close. The closed atomic boolean guarantees this will be called only once per wrapper.- Specified by:
- doClosein class- SocketWrapperBase<Nio2Channel>
 
- 
hasAsyncIOpublic boolean hasAsyncIO()Description copied from class:SocketWrapperBaseAllows using NIO2 style read/write.- Overrides:
- hasAsyncIOin class- SocketWrapperBase<Nio2Channel>
- Returns:
- trueif the connector has the capability enabled
 
- 
needSemaphorespublic boolean needSemaphores()Description copied from class:SocketWrapperBaseAllows indicating if the connector needs semaphores.- Overrides:
- needSemaphoresin class- SocketWrapperBase<Nio2Channel>
- Returns:
- This default implementation always returns false
 
- 
hasPerOperationTimeoutpublic boolean hasPerOperationTimeout()Description copied from class:SocketWrapperBaseAllows indicating if the connector supports per operation timeout.- Overrides:
- hasPerOperationTimeoutin class- SocketWrapperBase<Nio2Channel>
- Returns:
- This default implementation always returns false
 
- 
newOperationStateprotected <A> SocketWrapperBase<Nio2Channel>.OperationState<A> newOperationState(boolean read, ByteBuffer[] buffers, int offset, int length, SocketWrapperBase.BlockingMode block, long timeout, TimeUnit unit, A attachment, SocketWrapperBase.CompletionCheck check, CompletionHandler<Long, ? super A> handler, Semaphore semaphore, SocketWrapperBase<Nio2Channel>.VectoredIOCompletionHandler<A> completion) - Specified by:
- newOperationStatein class- SocketWrapperBase<Nio2Channel>
 
- 
writeNonBlockingTransfers the data to the socket write buffer (writing that data to the socket if the buffer fills up using a non-blocking write) until either all the data has been transferred and space remains in the socket write buffer or a non-blocking write leaves data in the socket write buffer. After an incomplete write, any data remaining to be transferred to the socket write buffer will be copied to the socket write buffer. If the remaining data is too big for the socket write buffer, the socket write buffer will be filled and the additional data written to the non-blocking write buffer.Overridden for NIO2 to enable a gathering write to be used to write all of the remaining data in a single additional write should a non-blocking write leave data in the buffer. - Overrides:
- writeNonBlockingin class- SocketWrapperBase<Nio2Channel>
- Parameters:
- buf- The byte array containing the data to be written
- off- The offset within the byte array of the data to be written
- len- The length of the data to be written
- Throws:
- IOException- If an IO error occurs during the write
 
- 
writeNonBlockingTransfers the data to the socket write buffer (writing that data to the socket if the buffer fills up using a non-blocking write) until either all the data has been transferred and space remains in the socket write buffer or a non-blocking write leaves data in the socket write buffer. After an incomplete write, any data remaining to be transferred to the socket write buffer will be copied to the socket write buffer. If the remaining data is too big for the socket write buffer, the socket write buffer will be filled and the additional data written to the non-blocking write buffer.Overridden for NIO2 to enable a gathering write to be used to write all of the remaining data in a single additional write should a non-blocking write leave data in the buffer. - Overrides:
- writeNonBlockingin class- SocketWrapperBase<Nio2Channel>
- Parameters:
- from- The ByteBuffer containing the data to be written
- Throws:
- IOException- If an IO error occurs during the write
 
- 
writeNonBlockingInternalSeparate method so it can be re-used by the socket write buffer to write data to the networkOverridden for NIO2 to enable a gathering write to be used to write all of the remaining data in a single additional write should a non-blocking write leave data in the buffer. - Overrides:
- writeNonBlockingInternalin class- SocketWrapperBase<Nio2Channel>
- Parameters:
- from- The ByteBuffer containing the data to be written
- Throws:
- IOException- If an IO error occurs during the write
 
- 
doWriteDescription copied from class:SocketWrapperBaseWrite 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:
- doWritein class- SocketWrapperBase<Nio2Channel>
- Parameters:
- block- Ignored since this method is only called in the blocking case
- from- the ByteBuffer containing the data to be written
- Throws:
- IOException- If an I/O error such as a timeout occurs during the write
 
- 
flushBlockingDescription copied from class:SocketWrapperBaseWrites all remaining data from the buffers and blocks until the write is complete.- Overrides:
- flushBlockingin class- SocketWrapperBase<Nio2Channel>
- Throws:
- IOException- If an IO error occurs during the write
 
- 
flushNonBlockingDescription copied from class:SocketWrapperBaseWrites as much data as possible from any that remains in the buffers.- Specified by:
- flushNonBlockingin class- SocketWrapperBase<Nio2Channel>
- Returns:
- trueif data remains to be flushed after this method completes, otherwise- false.
- Throws:
- IOException- If an IO error occurs during the write
 
- 
hasDataToReadpublic boolean hasDataToRead()- Overrides:
- hasDataToReadin class- SocketWrapperBase<Nio2Channel>
 
- 
hasDataToWritepublic boolean hasDataToWrite()- Overrides:
- hasDataToWritein class- SocketWrapperBase<Nio2Channel>
 
- 
isReadPendingpublic boolean isReadPending()Description copied from class:SocketWrapperBaseAllows checking if an asynchronous read operation is currently pending.- Overrides:
- isReadPendingin class- SocketWrapperBase<Nio2Channel>
- Returns:
- trueif the endpoint supports asynchronous IO and a read operation is being processed asynchronously
 
- 
isWritePendingpublic boolean isWritePending()Description copied from class:SocketWrapperBaseAllows checking if an asynchronous write operation is currently pending.- Overrides:
- isWritePendingin class- SocketWrapperBase<Nio2Channel>
- Returns:
- trueif the endpoint supports asynchronous IO and a write operation is being processed asynchronously
 
- 
registerReadInterestpublic void registerReadInterest()- Specified by:
- registerReadInterestin class- SocketWrapperBase<Nio2Channel>
 
- 
registerWriteInterestpublic void registerWriteInterest()- Specified by:
- registerWriteInterestin class- SocketWrapperBase<Nio2Channel>
 
- 
createSendfileData- Specified by:
- createSendfileDatain class- SocketWrapperBase<Nio2Channel>
 
- 
processSendfileDescription copied from class:SocketWrapperBaseStarts 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:
- processSendfilein class- SocketWrapperBase<Nio2Channel>
- Parameters:
- sendfileData- Data representing the file to send
- Returns:
- The state of the sendfile process after the first write.
 
- 
populateRemoteAddrprotected void populateRemoteAddr()- Specified by:
- populateRemoteAddrin class- SocketWrapperBase<Nio2Channel>
 
- 
populateRemoteHostprotected void populateRemoteHost()- Specified by:
- populateRemoteHostin class- SocketWrapperBase<Nio2Channel>
 
- 
populateRemotePortprotected void populateRemotePort()- Specified by:
- populateRemotePortin class- SocketWrapperBase<Nio2Channel>
 
- 
populateLocalNameprotected void populateLocalName()- Specified by:
- populateLocalNamein class- SocketWrapperBase<Nio2Channel>
 
- 
populateLocalAddrprotected void populateLocalAddr()- Specified by:
- populateLocalAddrin class- SocketWrapperBase<Nio2Channel>
 
- 
populateLocalPortprotected void populateLocalPort()- Specified by:
- populateLocalPortin class- SocketWrapperBase<Nio2Channel>
 
- 
getSslSupportDescription copied from class:SocketWrapperBaseObtain an SSLSupport instance for this socket.- Specified by:
- getSslSupportin class- SocketWrapperBase<Nio2Channel>
- Returns:
- An SSLSupport instance for this socket.
 
- 
doClientAuthDescription copied from class:SocketWrapperBaseRequire the client to perform CLIENT-CERT authentication if it hasn't already done so.- Specified by:
- doClientAuthin class- SocketWrapperBase<Nio2Channel>
- Parameters:
- sslSupport- The SSL/TLS support instance currently being used by the connection that may need updating after the client authentication
- Throws:
- 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- Specified by:
- setAppReadBufHandlerin class- SocketWrapperBase<Nio2Channel>
 
 
-