NioChannel (Apache Tomcat 7.0.67 API Documentation)

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

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.ByteChannel, java.nio.channels.Channel, java.nio.channels.ReadableByteChannel, java.nio.channels.WritableByteChannel

Direct Known Subclasses:

SecureNioChannel
```
public class NioChannel
extends java.lang.Object
implements java.nio.channels.ByteChannel
```
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.

Version:

1.0

Author:

Filip Hanik

Field Summary

Fields
Modifier and Type	Field and Description
`protected SecureNioChannel.ApplicationBufferHandler`	`bufHandler`
`protected static java.nio.ByteBuffer`	`emptyBuf`
`protected NioEndpoint.Poller`	`poller`
`protected java.nio.channels.SocketChannel`	`sc`
`protected static StringManager`	`sm`

Constructor Summary

Constructors
Constructor and Description

NioChannel(java.nio.channels.SocketChannel channel, SecureNioChannel.ApplicationBufferHandler bufHandler)

Constructors
Constructor and Description
`NioChannel(java.nio.channels.SocketChannel channel, SecureNioChannel.ApplicationBufferHandler bufHandler)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`checkInterruptStatus()` This method should be used to check the interrupt status before attempting a write.
`void`	`close()` Closes this channel.
`void`	`close(boolean force)`
`boolean`	`flush(boolean block, java.nio.channels.Selector s, long timeout)` Returns true if the network buffer has been flushed out and is empty.
`boolean`	`flushOutbound()` Return true if the buffer wrote data
`java.lang.Object`	`getAttachment()`
`int`	`getBufferSize()`
`SecureNioChannel.ApplicationBufferHandler`	`getBufHandler()` getBufHandler
`java.nio.channels.SocketChannel`	`getIOChannel()` getIOChannel
`int`	`getOutboundRemaining()`
`NioEndpoint.Poller`	`getPoller()`
`int`	`handshake(boolean read, boolean write)`
`boolean`	`isClosing()` isClosing
`boolean`	`isHandshakeComplete()` isInitHandshakeComplete
`boolean`	`isOpen()` Tells whether or not this channel is open.
`int`	`read(java.nio.ByteBuffer dst)` Reads a sequence of bytes from this channel into the given buffer.
`void`	`reset()`
`void`	`setIOChannel(java.nio.channels.SocketChannel IOChannel)`
`void`	`setPoller(NioEndpoint.Poller poller)`
`java.lang.String`	`toString()`
`int`	`write(java.nio.ByteBuffer src)` Writes a sequence of bytes to this channel from the given buffer.

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

- Field Detail
  - sm
```
protected static final StringManager sm
```
  - emptyBuf
```
protected static java.nio.ByteBuffer emptyBuf
```
  - sc
```
protected java.nio.channels.SocketChannel sc
```
  - bufHandler
```
protected SecureNioChannel.ApplicationBufferHandler bufHandler
```
  - poller
```
protected NioEndpoint.Poller poller
```
- Constructor Detail
  - NioChannel
```
public NioChannel(java.nio.channels.SocketChannel channel,
          SecureNioChannel.ApplicationBufferHandler bufHandler)
           throws java.io.IOException
```
    Throws:
    
    java.io.IOException
- Method Detail
  - reset
```
public void reset()
           throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getBufferSize
```
public int getBufferSize()
```
  - flush
```
public boolean flush(boolean block,
            java.nio.channels.Selector s,
            long timeout)
              throws java.io.IOException
```
    Returns true if the network buffer has been flushed out and is empty.
    
    Parameters:
    block - Unused. May be used when overridden
    s - Unused. May be used when overridden
    timeout - Unused. May be used when overridden
    
    Returns:
    Always returns true since there is no network buffer in the regular channel
    
    Throws:
    
    java.io.IOException
  - 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.Channel
    
    Throws:
    
    java.io.IOException - If an I/O error occurs TODO Implement this java.nio.channels.Channel method
  - 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 TODO Implement this java.nio.channels.Channel method
  - write
```
public int write(java.nio.ByteBuffer src)
          throws java.io.IOException
```
    Writes a sequence of bytes to this channel from the given buffer.
    
    Specified by:
    
    write in interface java.nio.channels.WritableByteChannel
    
    Parameters:
    src - The buffer from which bytes are to be retrieved
    
    Returns:
    The number of bytes written, possibly zero
    
    Throws:
    
    java.io.IOException - If some other I/O error occurs TODO Implement this java.nio.channels.WritableByteChannel method
  - read
```
public int read(java.nio.ByteBuffer dst)
         throws java.io.IOException
```
    Reads a sequence of bytes from this channel into the given buffer.
    
    Specified by:
    
    read in interface java.nio.channels.ReadableByteChannel
    
    Parameters:
    dst - The buffer into which bytes are to be transferred
    
    Returns:
    The number of bytes read, possibly zero, or -1 if the channel has reached end-of-stream
    
    Throws:
    
    java.io.IOException - If some other I/O error occurs TODO Implement this java.nio.channels.ReadableByteChannel method
  - getAttachment
```
public java.lang.Object getAttachment()
```
  - getBufHandler
```
public SecureNioChannel.ApplicationBufferHandler getBufHandler()
```
    getBufHandler
    
    Returns:
    ApplicationBufferHandler TODO Implement this org.apache.tomcat.util.net.SecureNioChannel method
  - getPoller
```
public NioEndpoint.Poller getPoller()
```
  - getIOChannel
```
public java.nio.channels.SocketChannel getIOChannel()
```
    getIOChannel
    
    Returns:
    SocketChannel TODO Implement this org.apache.tomcat.util.net.SecureNioChannel method
  - isClosing
```
public boolean isClosing()
```
    isClosing
    
    Returns:
    boolean TODO Implement this org.apache.tomcat.util.net.SecureNioChannel method
  - isHandshakeComplete
```
public boolean isHandshakeComplete()
```
    isInitHandshakeComplete
    
    Returns:
    boolean
  - handshake
```
public int handshake(boolean read,
            boolean write)
              throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - setPoller
```
public void setPoller(NioEndpoint.Poller poller)
```
  - setIOChannel
```
public void setIOChannel(java.nio.channels.SocketChannel IOChannel)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getOutboundRemaining
```
public int getOutboundRemaining()
```
  - flushOutbound
```
public boolean flushOutbound()
                      throws java.io.IOException
```
    Return true if the buffer wrote data
    
    Throws:
    
    java.io.IOException
  - checkInterruptStatus
```
protected void checkInterruptStatus()
                             throws java.io.IOException
```
    This method should be used to check the interrupt status before attempting a write. If a thread has been interrupted and the interrupt has not been cleared then an attempt to write to the socket will fail. When this happens the socket is removed from the poller without the socket being selected. This results in a connection limit leak for NIO as the endpoint expects the socket to be selected even in error conditions.
    
    Throws:
    
    java.io.IOException

Class NioChannel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sm

emptyBuf

sc

bufHandler

poller

Constructor Detail

NioChannel

Method Detail

reset

getBufferSize

flush

close

close

isOpen

write

read

getAttachment

getBufHandler

getPoller

getIOChannel

isClosing

isHandshakeComplete

handshake

setPoller

setIOChannel

toString

getOutboundRemaining

flushOutbound

checkInterruptStatus