com.ibasco.agql.protocols.valve.source.query.common.packets.util

Class SourceEagerSplitPacketAssembler

java.lang.Object

com.ibasco.agql.protocols.valve.source.query.common.packets.util.SourceEagerSplitPacketAssembler

All Implemented Interfaces:

SourceSplitPacketAssembler

public class SourceEagerSplitPacketAssembler
extends Object
implements SourceSplitPacketAssembler

Eager implementation of the SourceSplitPacketAssembler. The split-packet is decoded on-the-fly and the partial packet is then placed into a pre-allocated buffer whose size is determined based on the initial parameters provided by the incoming split-packet(s). The pre-allocated buffer can then be used as soon as it is marked as completed. Make sure to call reset() after consuming the buffer.

Author:

Rafael Luis Ibasco

Constructor Summary

Constructors

Constructor and Description
SourceEagerSplitPacketAssembler(io.netty.channel.ChannelHandlerContext ctx) Constructor for SourceEagerSplitPacketAssembler.

Method Summary

Modifier and Type	Method and Description
boolean	add(SourceQuerySplitPacket splitPacket) Adds a SourceQuerySplitPacket to the container.
int	count() count.
List<io.netty.buffer.ByteBuf>	dump() Dump a snapshot of the current received packets.
io.netty.buffer.ByteBuf	getBuffer() getBuffer.
boolean	isComplete() isComplete.
int	received() received.
void	reset() Resets the container back to it's initial state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibasco.agql.protocols.valve.source.query.common.packets.util.SourceSplitPacketAssembler

isProcessing

Constructor Detail

SourceEagerSplitPacketAssembler

public SourceEagerSplitPacketAssembler(io.netty.channel.ChannelHandlerContext ctx)

Constructor for SourceEagerSplitPacketAssembler.

Parameters:

ctx - a ChannelHandlerContext object

Method Detail

add

public boolean add(SourceQuerySplitPacket splitPacket)

Adds a SourceQuerySplitPacket to the container. Once an assembler is marked in a completed state, this method throws an IllegalStateException indicating that it is no longer accepting new packets. SourceSplitPacketAssembler.reset() should be called

Specified by:

add in interface SourceSplitPacketAssembler

Parameters:

splitPacket - The split-packet to be added. Note that packets can arrive at different order, as long as both the container and the split-packet are in a valid state, then calling this method should not fail.

Returns:

true if after calling this method caused the assembler in completed state (all split-packets have been received), false if not yet completed.

received

public int received()

received.

Specified by:

received in interface SourceSplitPacketAssembler

Returns:

The number of split-packets received by this container

isComplete

public boolean isComplete()

isComplete.

Specified by:

isComplete in interface SourceSplitPacketAssembler

Returns:

true if the container is now in completed state (all packets have been received). false if either the container has not been initialized (not collecting) or if the container is not yet marked in a completed state

See Also:

SourceSplitPacketAssembler.reset(), SourceSplitPacketAssembler.getBuffer()

getBuffer

public io.netty.buffer.ByteBuf getBuffer()

getBuffer.

Specified by:

getBuffer in interface SourceSplitPacketAssembler

Returns:

The ByteBuf containing the re-assembled packets.

count

public int count()

count.

Specified by:

count in interface SourceSplitPacketAssembler

Returns:

The total count of expected split-packets

reset

public void reset()

Resets the container back to it's initial state. This should be called only when the container has been marked in a completed state.

Specified by:

reset in interface SourceSplitPacketAssembler

See Also:

SourceSplitPacketAssembler.isComplete()

dump

public List<io.netty.buffer.ByteBuf> dump()

Dump a snapshot of the current received packets. This operation creates a copy of the packets.

Specified by:

dump in interface SourceSplitPacketAssembler

Returns:

A Map containing the currently received packets