net.openhft.chronicle.bytes

Class BytesMethodReader

java.lang.Object

net.openhft.chronicle.core.io.SimpleCloseable

net.openhft.chronicle.bytes.BytesMethodReader

All Implemented Interfaces:

Closeable, AutoCloseable, MethodReader, net.openhft.chronicle.core.io.ManagedCloseable, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceOwner

public class BytesMethodReader
extends net.openhft.chronicle.core.io.SimpleCloseable
implements MethodReader

The BytesMethodReader class provides a concrete implementation of the MethodReader interface. It extends SimpleCloseable and it's capable of reading serialized method calls from a BytesIn object. The class uses an instance of BytesParselet to define a default behavior when reading method calls, and a map of method encoders to decode serialized method calls into their original form.

The class also maintains an internal list of method encoders, which are stored in the order that they were added. This allows the BytesMethodReader to efficiently look up the appropriate method encoder based on a messageId.

The BytesMethodReader is not thread-safe.

Field Summary

Fields inherited from interface net.openhft.chronicle.bytes.MethodReader

HISTORY, MESSAGE_HISTORY_METHOD_ID

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT, TMP

Constructor Summary

Constructors

Constructor and Description
BytesMethodReader(BytesIn<?> in, BytesParselet defaultParselet, MethodEncoderLookup methodEncoderLookup, Object[] objects) Constructor for the BytesMethodReader class.

Method Summary

Modifier and Type	Method and Description
MethodReader	closeIn(boolean closeIn) Sets whether the underlying input should be closed when the MethodReader is closed.
MethodReaderInterceptorReturns	methodReaderInterceptorReturns() Throws an UnsupportedOperationException when called.
boolean	readOne() Attempts to read a single message from the BytesIn object.

Methods inherited from class net.openhft.chronicle.core.io.SimpleCloseable

close, isClosed, performClose

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

close, closeQuietly, closeQuietly

Methods inherited from interface net.openhft.chronicle.core.io.QueryCloseable

isClosed, isClosing

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

referenceId, referenceName, temporary

Methods inherited from interface net.openhft.chronicle.core.io.ManagedCloseable

createdHere, throwExceptionIfClosed, warnAndCloseIfNotClosed

Constructor Detail

BytesMethodReader

public BytesMethodReader(BytesIn<?> in,
                         BytesParselet defaultParselet,
                         MethodEncoderLookup methodEncoderLookup,
                         Object[] objects)

Constructor for the BytesMethodReader class.

Initializes a new instance of the BytesMethodReader with a BytesIn object, a default BytesParselet, and a methodEncoderLookup function. The constructor also accepts an array of objects which represent the possible targets for the method calls that this reader will dispatch.

Parameters:

in - the BytesIn object from which serialized method calls are read.

defaultParselet - the default BytesParselet used when reading method calls.

methodEncoderLookup - the lookup function used to find a method's encoder.

objects - the array of objects that can be targets of method calls.

Method Detail

methodReaderInterceptorReturns

public MethodReaderInterceptorReturns methodReaderInterceptorReturns()

Throws an UnsupportedOperationException when called.

This method is required to fulfill the MethodReader interface, but it is not supported in the BytesMethodReader class.

Specified by:

methodReaderInterceptorReturns in interface MethodReader

Returns:

nothing

Throws:

UnsupportedOperationException - always

readOne

public boolean readOne()
                throws net.openhft.chronicle.core.util.InvocationTargetRuntimeException,
                       IllegalStateException,
                       BufferUnderflowException

Attempts to read a single message from the BytesIn object.

If a suitable method encoder is found, it is used to decode the message and the corresponding method is invoked. Otherwise, the default parselet is used.

If the reader is closed or if there are no more messages to read, the method returns false.

Specified by:

readOne in interface MethodReader

Returns:

true if a message was successfully read, false if no more messages are available

Throws:

net.openhft.chronicle.core.util.InvocationTargetRuntimeException - If an exception is thrown by the target method

BufferUnderflowException - If there is not enough data available in the buffer to read the next message

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

closeIn

public MethodReader closeIn(boolean closeIn)

Sets whether the underlying input should be closed when the MethodReader is closed.

Note: This method currently does not alter the close behavior of the BytesMethodReader. It returns the MethodReader itself for method chaining.

Specified by:

closeIn in interface MethodReader

Parameters:

closeIn - true to close the input when this reader is closed, false otherwise

Returns:

the MethodReader itself, for method chaining