io.aeron

Class ImageControlledFragmentAssembler

java.lang.Object

io.aeron.ImageControlledFragmentAssembler

All Implemented Interfaces:

ControlledFragmentHandler

public class ImageControlledFragmentAssembler
extends java.lang.Object
implements ControlledFragmentHandler

A ControlledFragmentHandler that sits in a chain-of-responsibility pattern that reassembles fragmented messages so that the next handler in the chain only sees whole messages. This is for a single session on an Image and not for multiple session Images in a Subscription.

Unfragmented messages are delegated without copy. Fragmented messages are copied to a temporary buffer for reassembly before delegation.

The Header passed to the delegate on assembling a message will be that of the last fragment.

See Also:

Image.controlledPoll(ControlledFragmentHandler, int), Image.controlledPeek(long, ControlledFragmentHandler, long)

Nested Class Summary

Nested classes/interfaces inherited from interface io.aeron.logbuffer.ControlledFragmentHandler

ControlledFragmentHandler.Action

Constructor Summary

Constructors

Constructor and Description
ImageControlledFragmentAssembler(ControlledFragmentHandler delegate) Construct an adapter to reassemble message fragments and delegate on whole messages.
ImageControlledFragmentAssembler(ControlledFragmentHandler delegate, int initialBufferLength) Construct an adapter to reassemble message fragments and delegate on whole messages.
ImageControlledFragmentAssembler(ControlledFragmentHandler delegate, int initialBufferLength, boolean isDirectByteBuffer) Construct an adapter to reassemble message fragments and delegate on whole messages.

Method Summary

Modifier and Type	Method and Description
ControlledFragmentHandler	delegate() Get the delegate unto which assembled messages are delegated.
ControlledFragmentHandler.Action	onFragment(org.agrona.DirectBuffer buffer, int offset, int length, Header header) The implementation of ControlledFragmentHandler that reassembles and forwards whole messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageControlledFragmentAssembler

public ImageControlledFragmentAssembler(ControlledFragmentHandler delegate)

Construct an adapter to reassemble message fragments and delegate on whole messages.

Parameters:

delegate - onto which whole messages are forwarded.

ImageControlledFragmentAssembler

public ImageControlledFragmentAssembler(ControlledFragmentHandler delegate,
                                        int initialBufferLength)

Construct an adapter to reassemble message fragments and delegate on whole messages.

Parameters:

delegate - onto which whole messages are forwarded.

initialBufferLength - to be used for the session.

ImageControlledFragmentAssembler

public ImageControlledFragmentAssembler(ControlledFragmentHandler delegate,
                                        int initialBufferLength,
                                        boolean isDirectByteBuffer)

Construct an adapter to reassemble message fragments and delegate on whole messages.

Parameters:

delegate - onto which whole messages are forwarded.

initialBufferLength - to be used for the session.

isDirectByteBuffer - is the underlying buffer to be a direct ByteBuffer?

Method Detail

delegate

public ControlledFragmentHandler delegate()

Get the delegate unto which assembled messages are delegated.

Returns:

the delegate unto which assembled messages are delegated.

onFragment

public ControlledFragmentHandler.Action onFragment(org.agrona.DirectBuffer buffer,
                                                   int offset,
                                                   int length,
                                                   Header header)

The implementation of ControlledFragmentHandler that reassembles and forwards whole messages.

Specified by:

onFragment in interface ControlledFragmentHandler

Parameters:

buffer - containing the data.

offset - at which the data begins.

length - of the data in bytes.

header - representing the meta data for the data.

Returns:

The action to be taken with regard to the stream position after the callback.