net.openhft.chronicle.bytes

Interface MethodReader

All Superinterfaces:

AutoCloseable, Closeable, net.openhft.chronicle.core.io.QueryCloseable

All Known Implementing Classes:

BytesMethodReader

public interface MethodReader
extends net.openhft.chronicle.core.io.Closeable

Interface defining the required operations for a method reader.

A method reader is responsible for reading serialized method calls, typically from a queue or a stream, and then dispatching those method calls to their intended target.

The reader provides a means to intercept method calls and control whether the underlying input should be closed when the reader itself is closed.

This interface extends Closeable, so any class implementing this interface can also be safely closed.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HISTORY
static int	MESSAGE_HISTORY_METHOD_ID

Method Summary

Modifier and Type	Method and Description
MethodReader	closeIn(boolean closeIn) Determines whether the underlying input should be closed when the MethodReader is closed.
MethodReaderInterceptorReturns	methodReaderInterceptorReturns() Returns a MethodReaderInterceptorReturns instance which can be used to control the flow of method calls.
boolean	readOne() Attempts to read a single message from the input, if one is available.

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

Field Detail

HISTORY

static final String HISTORY

See Also:

Constant Field Values

MESSAGE_HISTORY_METHOD_ID

static final int MESSAGE_HISTORY_METHOD_ID

See Also:

Constant Field Values

Method Detail

methodReaderInterceptorReturns

MethodReaderInterceptorReturns methodReaderInterceptorReturns()

Returns a MethodReaderInterceptorReturns instance which can be used to control the flow of method calls.

Returns:

a MethodReaderInterceptorReturns instance

readOne

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

Attempts to read a single message from the input, if one is available.

If an exception is thrown while dispatching the method call, this should be caught and logged. If an exception is thrown by the target method itself, this is wrapped in an InvocationTargetRuntimeException and rethrown.

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

MethodReader closeIn(boolean closeIn)

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

If closeIn is set to true, closing the MethodReader will also close the underlying input. If closeIn is set to false, the underlying input will remain open after the MethodReader is closed.

Parameters:

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

Returns:

the MethodReader itself, for method chaining