SourceSplitPacketAssembler (Asynchronous Game Query Library 1.2.2 API)

All Known Implementing Classes:

SourceEagerSplitPacketAssembler, SourceLazySplitPacketAssembler
```
public interface SourceSplitPacketAssembler
```
A re-usable class for processing SourceQuerySplitPacket instances.

Author:

Rafael Luis Ibasco

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`boolean`	`add(SourceQuerySplitPacket packet)` 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.
`default boolean`	`isProcessing()` isProcessing.
`int`	`received()` received.
`void`	`reset()` Resets the container back to it's initial state.

- Method Detail
  - add
```
boolean add(SourceQuerySplitPacket packet)
```
    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. reset() should be called
    
    Parameters:
    
    packet - 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.
    
    Throws:
    
    IllegalStateException - If the assembler has not been initialized or has already been marked as completed.
    
    IndexOutOfBoundsException - if the packet is not within bounds of the pre-allocated buffer
  - isProcessing
```
default boolean isProcessing()
```
    isProcessing.
    
    Returns:
    
    true if the assembler is currently processing split-packets. This is similar to calling size() > 0 && !isComplete()
    
    See Also:
    
    received(), isComplete()
  - received
```
int received()
```
    received.
    
    Returns:
    
    The number of split-packets received by this container
  - isComplete
```
boolean isComplete()
```
    isComplete.
    
    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:
    
    reset(), getBuffer()
  - getBuffer
```
io.netty.buffer.ByteBuf getBuffer()
```
    getBuffer.
    
    Returns:
    
    The ByteBuf containing the re-assembled packets.
    
    Throws:
    
    IllegalStateException - is the assembler is not yet in a completed state
  - count
```
int count()
```
    count.
    
    Returns:
    
    The total count of expected split-packets
  - reset
```
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.
    
    See Also:
    
    isComplete()
  - dump
```
List<io.netty.buffer.ByteBuf> dump()
```
    Dump a snapshot of the current received packets. This operation creates a copy of the packets.
    
    Returns:
    
    A Map containing the currently received packets

Interface SourceSplitPacketAssembler

Method Summary

Method Detail

add

isProcessing

received

isComplete

getBuffer

count

reset

dump