Overrides org.apache.tomcat.util.net.NioChannel.close.

Implements java.nio.channels.Channel.close.

Sends an SSL close message, will not physically close the connection here.
To close the connection, you could do something like

  close();
  while (isOpen() && !myTimeoutFunction()) Thread.sleep(25);
  if ( isOpen() ) close(true); //forces a close if you timed out

Annotations

@Override

Exceptions

IOException:

• if an I/O error occurs
• if there is data on the outgoing network buffer and we are unable to flush it

Overrides org.apache.tomcat.util.net.NioChannel.close.

Doc from org.apache.tomcat.util.net.NioChannel.close.

Close the connection.

Parameters

force:boolean

Should the underlying socket be forcibly closed?

Annotations

@Override

Exceptions

IOException:

If closing the secure channel fails.

Overrides org.apache.tomcat.util.net.NioChannel.flushOutbound.

Doc from org.apache.tomcat.util.net.NioChannel.flushOutbound.

Return true if the buffer wrote data. NO-OP for non-secure channel.

Returns:boolean

Always returns false for non-secure channel

Annotations

@Override

Exceptions

IOException:

Never for non-secure channel

Overrides org.apache.tomcat.util.net.NioChannel.free.

Doc from org.apache.tomcat.util.net.NioChannel.free.

Free the channel memory

Annotations

@Override

Overrides org.apache.tomcat.util.net.NioChannel.getOutboundRemaining.

Annotations

@Override

Overrides org.apache.tomcat.util.net.NioChannel.handshake.

Performs SSL handshake, non blocking, but performs NEED_TASK on the same thread. Hence, you should never call this method using your Acceptor thread, as you would slow down your system significantly. If the return value from this method is positive, the selection key should be registered interestOps given by the return value.

Parameters

read:boolean

boolean - true if the underlying channel is readable

write:boolean

boolean - true if the underlying channel is writable

Returns:int

0 if hand shake is complete, -1 if an error (other than an IOException) occurred, otherwise it returns a SelectionKey interestOps value

Annotations

@Override

Exceptions

IOException:

If an I/O error occurs during the handshake or if the handshake fails during wrapping or unwrapping

Overrides org.apache.tomcat.util.net.NioChannel.isClosing.

Annotations

@Override

Overrides org.apache.tomcat.util.net.NioChannel.isHandshakeComplete.

Annotations

@Override

Overrides org.apache.tomcat.util.net.NioChannel.read.

Implements java.nio.channels.ReadableByteChannel.read.

Reads a sequence of bytes from this channel into the given buffer.

Parameters

dst:ByteBuffer

The buffer into which bytes are to be transferred

Returns:int

The number of bytes read, possibly zero, or -1 if the channel has reached end-of-stream

Annotations

@Override

Exceptions

IOException:

If some other I/O error occurs

IllegalArgumentException:

if the destination buffer is different than getBufHandler().getReadBuffer()

Overrides org.apache.tomcat.util.net.NioChannel.read.

Implements java.nio.channels.ScatteringByteChannel.read.

Doc from java.nio.channels.ScatteringByteChannel.read.

Reads a sequence of bytes from this channel into a subsequence of the given buffers.

An invocation of this method attempts to read up to r bytes from this channel, where r is the total number of bytes remaining in the specified subsequence of the given buffer array, that is,

dsts[offset].remaining()
    + dsts[offset+1].remaining()
    + ... + dsts[offset+length-1].remaining()

Suppose that a byte sequence of length n is read, where 0 <= n <= r. Up to the first dsts[offset].remaining() bytes of this sequence are transferred into buffer dsts[offset], up to the next dsts[offset+1].remaining() bytes are transferred into buffer dsts[offset+1], and so forth, until the entire byte sequence is transferred into the given buffers. As many bytes as possible are transferred into each buffer, hence the final position of each updated buffer, except the last updated buffer, is guaranteed to be equal to that buffer's limit.

This method may be invoked at any time. If another thread has already initiated a read operation upon this channel, however, then an invocation of this method will block until the first operation is complete.

Parameters

dsts:ByteBuffer[]

The buffers into which bytes are to be transferred

offset:int

The offset within the buffer array of the first buffer into which bytes are to be transferred; must be non-negative and no larger than dsts.length

length:int

The maximum number of buffers to be accessed; must be non-negative and no larger than dsts.length - offset

Returns:long

The number of bytes read, possibly zero, or -1 if the channel has reached end-of-stream

Annotations

@Override

Exceptions

IOException:

If some other I/O error occurs

Force a blocking handshake to take place for this key. This requires that both network and application buffers have been emptied out prior to this call taking place, or a IOException will be thrown.

Parameters

timeout:long

- timeout in milliseconds for each socket operation

Annotations

@SuppressWarnings:null

Exceptions

IOException:

- if an IO exception occurs or if application or network buffers contain data

SocketTimeoutException:

- if a socket operation timed out

Overrides org.apache.tomcat.util.net.NioChannel.reset.

Doc from org.apache.tomcat.util.net.NioChannel.reset.

Reset the channel

Parameters

channel:SocketChannel

the socket channel

socketWrapper:NioEndpoint.NioSocketWrapper

the socket wrapper

Annotations

@Override

Exceptions

IOException:

If a problem was encountered resetting the channel

Overrides org.apache.tomcat.util.net.NioChannel.write.

Implements java.nio.channels.WritableByteChannel.write.

Writes a sequence of bytes to this channel from the given buffer.

Parameters

src:ByteBuffer

The buffer from which bytes are to be retrieved

Returns:int

The number of bytes written, possibly zero

Annotations

@Override

Exceptions

IOException:

If some other I/O error occurs

Overrides org.apache.tomcat.util.net.NioChannel.write.

Implements java.nio.channels.GatheringByteChannel.write.

Doc from java.nio.channels.GatheringByteChannel.write.

Writes a sequence of bytes to this channel from a subsequence of the given buffers.

An attempt is made to write up to r bytes to this channel, where r is the total number of bytes remaining in the specified subsequence of the given buffer array, that is,

srcs[offset].remaining()
    + srcs[offset+1].remaining()
    + ... + srcs[offset+length-1].remaining()

Suppose that a byte sequence of length n is written, where 0 <= n <= r. Up to the first srcs[offset].remaining() bytes of this sequence are written from buffer srcs[offset], up to the next srcs[offset+1].remaining() bytes are written from buffer srcs[offset+1], and so forth, until the entire byte sequence is written. As many bytes as possible are written from each buffer, hence the final position of each updated buffer, except the last updated buffer, is guaranteed to be equal to that buffer's limit.

Unless otherwise specified, a write operation will return only after writing all of the r requested bytes. Some types of channels, depending upon their state, may write only some of the bytes or possibly none at all. A socket channel in non-blocking mode, for example, cannot write any more bytes than are free in the socket's output buffer.

This method may be invoked at any time. If another thread has already initiated a write operation upon this channel, however, then an invocation of this method will block until the first operation is complete.

Parameters

srcs:ByteBuffer[]

The buffers from which bytes are to be retrieved

offset:int

The offset within the buffer array of the first buffer from which bytes are to be retrieved; must be non-negative and no larger than srcs.length

length:int

The maximum number of buffers to be accessed; must be non-negative and no larger than srcs.length - offset

Returns:long

The number of bytes written, possibly zero

Annotations

@Override

Exceptions

IOException:

If some other I/O error occurs