org.snf4j.core

Interface IStreamReader

All Known Subinterfaces:

IStreamHandler, IWebSocketHandler

All Known Implementing Classes:

AbstractFileHandler, AbstractProxyHandler, AbstractSocksProxyHandler, AbstractStreamHandler, AbstractWebSocketHandler, ChatClientHandler, ChatServerHandler, DiscardingClientHandler, DiscardingServerHandler, EchoClientHandler, EchoServerHandler, EngineClientHandler, EngineServerHandler, FileClientHandler, HttpProxyHandler, Socks4ProxyHandler, Socks5ProxyHandler, WebSocketClientHandler, WebSocketServerHandler

public interface IStreamReader

A reader that reads data directly from a stream channel.

Author:

SNF4J.ORG

Method Summary

Modifier and Type	Method and Description
int	available(byte[] buffer, int off, int len) Determines how many bytes can be read from the input buffer after receiving new data from the remote end.
int	available(ByteBuffer buffer, boolean flipped) Determines how many bytes can be read from the input buffer after receiving new data from the remote end.
void	read(byte[] data) Called when new bytes were read from the input buffer.
void	read(ByteBuffer data) Called when new bytes were read from the input buffer.

Method Detail

available

int available(ByteBuffer buffer,
              boolean flipped)

Determines how many bytes can be read from the input buffer after receiving new data from the remote end. The specified number of bytes will be then passed as a byte array to the read method.

This method is called only if the input buffer is not backed by an array. The type of the input buffer is specified by the implementation of the ISessionStructureFactory returned by the getFactory method.

The inner state of the passed buffer cannot be changed by this method.

Parameters:

buffer - the input buffer.

flipped - specifies the current mode of the buffer

Returns:

the number of bytes to read or 0 if the buffer has not enough data yet and the reading should skipped now.

available

int available(byte[] buffer,
              int off,
              int len)

Determines how many bytes can be read from the input buffer after receiving new data from the remote end. The specified number of bytes will be then passed as a byte array to the read method.

This method is called only if the input buffer is backed by an array. The type of the input buffer is specified by the implementation of the ISessionStructureFactory returned by the getFactory method.

The content of the passed buffer cannot be changed by this method.

Parameters:

buffer - the array that backs the input buffer.

off - the offset of the array

len - the number of the bytes in the array

Returns:

number of bytes to read or 0 if the buffer has not enough data yet and the reading should skipped now.

read

void read(byte[] data)

Called when new bytes were read from the input buffer. The number of bytes in the passed array is determined by the value returned from the available method that was called recently.

The passed array can be safely stored or modified by this method as it will not be used by the caller.

Parameters:

data - bytes that was read from the input buffer.

read

void read(ByteBuffer data)

Called when new bytes were read from the input buffer. This method is called when the associated session is configured to optimize data copying and uses an allocator supporting the releasing of no longer used buffers.

Parameters:

data - bytes that was read from the input buffer.