Nio2Channel (Apache Tomcat 8.0.53 API Documentation)

java.lang.Object
- org.apache.tomcat.util.net.Nio2Channel

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.AsynchronousByteChannel, java.nio.channels.AsynchronousChannel, java.nio.channels.Channel

Direct Known Subclasses:

SecureNio2Channel
```
public class Nio2Channel
extends java.lang.Object
implements java.nio.channels.AsynchronousByteChannel
```
Base class for a SocketChannel wrapper used by the endpoint. This way, logic for a SSL socket channel remains the same as for a non SSL, making sure we don't need to code for any exception cases.

Field Summary

Fields
Modifier and Type	Field and Description
`protected SecureNio2Channel.ApplicationBufferHandler`	`bufHandler`
`protected static java.nio.ByteBuffer`	`emptyBuf`
`protected java.nio.channels.AsynchronousSocketChannel`	`sc`
`protected SocketWrapper<Nio2Channel>`	`socket`

Constructor Summary

Constructors
Constructor and Description

Nio2Channel(SecureNio2Channel.ApplicationBufferHandler bufHandler)

Constructors
Constructor and Description
`Nio2Channel(SecureNio2Channel.ApplicationBufferHandler bufHandler)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Closes this channel.
`void`	`close(boolean force)`
`java.util.concurrent.Future<java.lang.Boolean>`	`flush()`
`int`	`getBufferSize()`
`SecureNio2Channel.ApplicationBufferHandler`	`getBufHandler()`
`java.nio.channels.AsynchronousSocketChannel`	`getIOChannel()`
`SocketWrapper<Nio2Channel>`	`getSocket()`
`int`	`handshake()` Performs SSL handshake hence is a no-op for the non-secure implementation.
`boolean`	`isClosing()`
`boolean`	`isHandshakeComplete()`
`boolean`	`isOpen()` Tells whether or not this channel is open.
`java.util.concurrent.Future<java.lang.Integer>`	`read(java.nio.ByteBuffer dst)`
`<A> void`	`read(java.nio.ByteBuffer dst, A attachment, java.nio.channels.CompletionHandler<java.lang.Integer,? super A> handler)`
`<A> void`	`read(java.nio.ByteBuffer dst, long timeout, java.util.concurrent.TimeUnit unit, A attachment, java.nio.channels.CompletionHandler<java.lang.Integer,? super A> handler)`
`void`	`reset(java.nio.channels.AsynchronousSocketChannel channel, SocketWrapper<Nio2Channel> socket)` Reset the channel
`java.lang.String`	`toString()`
`java.util.concurrent.Future<java.lang.Integer>`	`write(java.nio.ByteBuffer src)`
`<A> void`	`write(java.nio.ByteBuffer[] srcs, int offset, int length, long timeout, java.util.concurrent.TimeUnit unit, A attachment, java.nio.channels.CompletionHandler<java.lang.Long,? super A> handler)`
`<A> void`	`write(java.nio.ByteBuffer src, A attachment, java.nio.channels.CompletionHandler<java.lang.Integer,? super A> handler)`
`<A> void`	`write(java.nio.ByteBuffer src, long timeout, java.util.concurrent.TimeUnit unit, A attachment, java.nio.channels.CompletionHandler<java.lang.Integer,? super A> handler)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

emptyBuf

protected static java.nio.ByteBuffer emptyBuf

sc

protected java.nio.channels.AsynchronousSocketChannel sc

socket

protected SocketWrapper<Nio2Channel> socket

bufHandler

protected SecureNio2Channel.ApplicationBufferHandler bufHandler

Constructor Detail

Nio2Channel

public Nio2Channel(SecureNio2Channel.ApplicationBufferHandler bufHandler)

Method Detail

reset

public void reset(java.nio.channels.AsynchronousSocketChannel channel,
         SocketWrapper<Nio2Channel> socket)
           throws java.io.IOException

Reset the channel

Throws:: java.io.IOException - If a problem was encountered resetting the channel

getSocket

public SocketWrapper<Nio2Channel> getSocket()

getBufferSize
```
public int getBufferSize()
```

close
```
public void close()
           throws java.io.IOException
```
Closes this channel.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.nio.channels.AsynchronousChannel

Specified by:

close in interface java.nio.channels.Channel

Throws:

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

close

public void close(boolean force)
           throws java.io.IOException

Throws:: java.io.IOException

isOpen
```
public boolean isOpen()
```
Tells whether or not this channel is open.

Specified by:

isOpen in interface java.nio.channels.Channel

Returns:
true if, and only if, this channel is open

getBufHandler

public SecureNio2Channel.ApplicationBufferHandler getBufHandler()

getIOChannel

public java.nio.channels.AsynchronousSocketChannel getIOChannel()

isClosing
```
public boolean isClosing()
```

isHandshakeComplete
```
public boolean isHandshakeComplete()
```

handshake
```
public int handshake()
              throws java.io.IOException
```
Performs SSL handshake hence is a no-op for the non-secure implementation.

Returns:
Always returns zero

Throws:

java.io.IOException

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

read

public java.util.concurrent.Future<java.lang.Integer> read(java.nio.ByteBuffer dst)

Specified by:: read in interface java.nio.channels.AsynchronousByteChannel

read

public <A> void read(java.nio.ByteBuffer dst,
            A attachment,
            java.nio.channels.CompletionHandler<java.lang.Integer,? super A> handler)

Specified by:: read in interface java.nio.channels.AsynchronousByteChannel

read

public <A> void read(java.nio.ByteBuffer dst,
            long timeout,
            java.util.concurrent.TimeUnit unit,
            A attachment,
            java.nio.channels.CompletionHandler<java.lang.Integer,? super A> handler)

write

public java.util.concurrent.Future<java.lang.Integer> write(java.nio.ByteBuffer src)

Specified by:: write in interface java.nio.channels.AsynchronousByteChannel

write

public <A> void write(java.nio.ByteBuffer src,
             A attachment,
             java.nio.channels.CompletionHandler<java.lang.Integer,? super A> handler)

Specified by:: write in interface java.nio.channels.AsynchronousByteChannel

write

public <A> void write(java.nio.ByteBuffer src,
             long timeout,
             java.util.concurrent.TimeUnit unit,
             A attachment,
             java.nio.channels.CompletionHandler<java.lang.Integer,? super A> handler)

write

public <A> void write(java.nio.ByteBuffer[] srcs,
             int offset,
             int length,
             long timeout,
             java.util.concurrent.TimeUnit unit,
             A attachment,
             java.nio.channels.CompletionHandler<java.lang.Long,? super A> handler)

flush

public java.util.concurrent.Future<java.lang.Boolean> flush()

Class Nio2Channel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

emptyBuf

sc

socket

bufHandler

Constructor Detail

Nio2Channel

Method Detail

reset

getSocket

getBufferSize

close

close

isOpen

getBufHandler

getIOChannel

isClosing

isHandshakeComplete

handshake

toString

read

read

read

write

write

write

write

flush