org.snf4j.core.codec

Interface IBaseDecoder<O>

Type Parameters:

O - the type of the produced outbound objects

All Superinterfaces:

ICodec<byte[],O>, IDecoder<byte[],O>

public interface IBaseDecoder<O>
extends IDecoder<byte[],O>

A special decoder that can determine how many bytes should be read from the input buffer to create the byte array of the inbound data that can be decoded by this decoder.

The special functionality (calling of the available methods) of this decoder will only work if this decoder is the first decoder in the pipeline. Otherwise, it will work as a regular decoder.

Author:

SNF4J.ORG

Method Summary

Modifier and Type	Method and Description
int	available(ISession session, byte[] buffer, int off, int len) Determines how many bytes should be read from the input buffer to create the byte array that will be then passed to the IDecoder.decode(org.snf4j.core.session.ISession, I, java.util.List<O>) method.
int	available(ISession session, ByteBuffer buffer, boolean flipped) Determines how many bytes should be read from the input buffer to create the byte array that will be then passed to the IDecoder.decode(org.snf4j.core.session.ISession, I, java.util.List<O>) method.

Methods inherited from interface org.snf4j.core.codec.IDecoder

decode

Methods inherited from interface org.snf4j.core.codec.ICodec

getInboundType, getOutboundType

Method Detail

available

int available(ISession session,
              ByteBuffer buffer,
              boolean flipped)

Determines how many bytes should be read from the input buffer to create the byte array that will be then passed to the IDecoder.decode(org.snf4j.core.session.ISession, I, java.util.List<O>) method.

This method is called only if the input buffer is not backed by an array (i.e. a direct byte buffer allocator is used to create session's internal buffers).

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

Parameters:

session - the ISession which the buffer belongs to

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(ISession session,
              byte[] buffer,
              int off,
              int len)

Determines how many bytes should be read from the input buffer to create the byte array that will be then passed to the IDecoder.decode(org.snf4j.core.session.ISession, I, java.util.List<O>) method.

This method is called only if the input buffer is backed by an array. (i.e. a heap byte buffer allocator is used to create session's internal buffers).

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

Parameters:

session - the ISession which the buffer belongs to

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.