org.apache.tomcat.util.net
Class NioChannel

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

All Implemented Interfaces:

java.io.Closeable, 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

emptyBuf

protected static java.nio.ByteBuffer emptyBuf

sc

protected java.nio.channels.SocketChannel sc

bufHandler

protected SecureNioChannel.ApplicationBufferHandler bufHandler

poller

protected NioEndpoint.Poller poller

NioChannel

public NioChannel(java.nio.channels.SocketChannel channel,
                  SecureNioChannel.ApplicationBufferHandler bufHandler)
           throws java.io.IOException

Throws:

java.io.IOException

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,
                     MutableInteger lastWrite)
              throws java.io.IOException

returns true if the network buffer has been flushed out and is empty

Returns:

boolean

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.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

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

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

getAttachment

public java.lang.Object getAttachment(boolean remove)

getBufHandler

public SecureNioChannel.ApplicationBufferHandler getBufHandler()

getPoller

public NioEndpoint.Poller getPoller()

getIOChannel

public java.nio.channels.SocketChannel getIOChannel()

isClosing

public boolean isClosing()

isInitHandshakeComplete

public boolean isInitHandshakeComplete()

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