GigaSpaces XAP 9.1 API

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
 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.
 com.gigaspaces.lrmi.nio.filters.IOFilterResult.HandshakeStatus getHandshakeStatus()
          Report the Hanshake status.
 int getPacketBufferSize()
          Return the network max block size
 com.gigaspaces.lrmi.nio.filters.IOFilterResult unwrap(ByteBuffer src, ByteBuffer dst)
          Unwrap some bytes
 com.gigaspaces.lrmi.nio.filters.IOFilterResult wrap(ByteBuffer src, ByteBuffer dst)
          Wrap some bytes
 
Methods inherited from interface com.gigaspaces.lrmi.nio.filters.IOFilter
setRemoteAddress
 

Method Detail

beginHandshake

void beginHandshake()
                    throws com.gigaspaces.lrmi.nio.filters.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

com.gigaspaces.lrmi.nio.filters.IOFilterResult.HandshakeStatus getHandshakeStatus()
Report the Hanshake status.

Returns:
hanshake status

wrap

com.gigaspaces.lrmi.nio.filters.IOFilterResult wrap(ByteBuffer src,
                                                    ByteBuffer dst)
                                                    throws com.gigaspaces.lrmi.nio.filters.IOFilterException
Wrap some bytes

Parameters:
src - source buffer
dst - target buffer
Returns:
filter result
Throws:
IOFilterException

unwrap

com.gigaspaces.lrmi.nio.filters.IOFilterResult unwrap(ByteBuffer src,
                                                      ByteBuffer dst)
                                                      throws com.gigaspaces.lrmi.nio.filters.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

GigaSpaces XAP 9.1 API

Copyright © GigaSpaces.