com.gigaspaces.lrmi.nio.filters

Interface IOBlockFilter

All Superinterfaces:

IOFilter

All Known Implementing Classes:

IOSSLFilter

public interface IOBlockFilter
extends IOFilter

Interface for block type network filters. Block network filter is filter that works in blocks. It have network buffer size and packet buffer size that the define the max block size for each direction.

Author:

barak

Method Summary

Modifier and Type	Method and Description
void	beginHandshake() Initiation of handshake process.
int	getApplicationBufferSize() Return the application max block size
Runnable	getDelegatedTask() When filter wish to do some calculation this is the way to handle the calculation code to the filter container.
IOFilterResult.HandshakeStatus	getHandshakeStatus() Report the Hanshake status.
int	getPacketBufferSize() Return the network max block size
IOFilterResult	unwrap(ByteBuffer src, ByteBuffer dst) Unwrap some bytes
IOFilterResult	wrap(ByteBuffer src, ByteBuffer dst) Wrap some bytes

Method Detail

beginHandshake

void beginHandshake()
             throws IOFilterException

Initiation of handshake process.

Throws:

IOFilterException

getDelegatedTask

Runnable getDelegatedTask()

When filter wish to do some calculation this is the way to handle the calculation code to the filter container.

Returns:

task to run

getHandshakeStatus

IOFilterResult.HandshakeStatus getHandshakeStatus()

Report the Hanshake status.

Returns:

hanshake status

wrap

IOFilterResult wrap(ByteBuffer src,
                    ByteBuffer dst)
             throws IOFilterException

Wrap some bytes

Parameters:

src - source buffer

dst - target buffer

Returns:

filter result

Throws:

IOFilterException

unwrap

IOFilterResult unwrap(ByteBuffer src,
                      ByteBuffer dst)
               throws IOFilterException

Unwrap some bytes

Parameters:

src - source buffer

dst - target buffer

Returns:

filter result

Throws:

IOFilterException

getApplicationBufferSize

int getApplicationBufferSize()

Return the application max block size

Returns:

application max block size

getPacketBufferSize

int getPacketBufferSize()

Return the network max block size

Returns:

network max block size