org.opendaylight.controller.cluster.messaging

Class AssembledMessageState

java.lang.Object

org.opendaylight.controller.cluster.messaging.AssembledMessageState

All Implemented Interfaces:

AutoCloseable

@NotThreadSafe
public class AssembledMessageState
extends Object
implements AutoCloseable

Maintains the state of an assembled message.

Author:

Thomas Pantelis

Constructor Summary

Constructors

Constructor and Description
AssembledMessageState(org.opendaylight.yangtools.concepts.Identifier identifier, int totalSlices, FileBackedOutputStreamFactory fileBackedStreamFactory, String logContext) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	addSlice(int sliceIndex, byte[] data, int lastSliceHashCode) Adds a slice to the assembled stream.
void	close()
com.google.common.io.ByteSource	getAssembledBytes() Returns the assembled bytes as a ByteSource.
org.opendaylight.yangtools.concepts.Identifier	getIdentifier() Returns the identifier of this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

AssembledMessageState

public AssembledMessageState(org.opendaylight.yangtools.concepts.Identifier identifier,
                             int totalSlices,
                             FileBackedOutputStreamFactory fileBackedStreamFactory,
                             String logContext)

Constructor.

Parameters:

identifier - the identifier for this instance

totalSlices - the total number of slices to expect

fileBackedStreamFactory - factory for creating the FileBackedOutputStream instance used for streaming

logContext - the context for log messages

Method Detail

getIdentifier

public org.opendaylight.yangtools.concepts.Identifier getIdentifier()

Returns the identifier of this instance.

Returns:

the identifier

addSlice

public boolean addSlice(int sliceIndex,
                        byte[] data,
                        int lastSliceHashCode)
                 throws MessageSliceException

Adds a slice to the assembled stream.

Parameters:

sliceIndex - the index of the slice

data - the sliced data

lastSliceHashCode - the hash code of the last slice sent

Returns:

true if this is the last slice received, false otherwise

Throws:

MessageSliceException -

• if the slice index is invalid
• if the last slice hash code is invalid
• if an error occurs writing the data to the stream

In addition, this instance is automatically closed and can no longer be used.

AssemblerSealedException - if this instance is already sealed (ie has received all the slices)

AssemblerClosedException - if this instance is already closed

getAssembledBytes

public com.google.common.io.ByteSource getAssembledBytes()
                                                  throws IOException

Returns the assembled bytes as a ByteSource. This method must only be called after this instance is sealed.

Returns:

a ByteSource containing the assembled bytes

Throws:

IOException - if an error occurs obtaining the assembled bytes

IllegalStateException - is this instance is not sealed

close

public void close()

Specified by:

close in interface AutoCloseable