net.openhft.chronicle.wire

Class VanillaMethodReader

java.lang.Object

net.openhft.chronicle.wire.VanillaMethodReader

All Implemented Interfaces:

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

public class VanillaMethodReader
extends Object
implements net.openhft.chronicle.bytes.MethodReader

Deserialises messages from a MarshallableIn source and dispatches each one as a method call on the supplied handler objects. A WireParser maps event names or method identifiers to the correct handler method.

The reader can operate either via a slower reflection proxy (deprecated) or a generated high-performance implementation, see GenerateMethodReader. Use VanillaMethodReaderBuilder to configure instances.

Supports interception via MethodReaderInterceptorReturns and custom parsing through WireParselet and FieldNumberParselet.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG_ENABLED Flag to enable debug logging of messages being read.

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

HISTORY, MESSAGE_HISTORY_METHOD_ID

Constructor Summary

Constructors

Constructor and Description
VanillaMethodReader(MarshallableIn in, boolean ignoreDefault, WireParselet defaultParselet, FieldNumberParselet fieldNumberParselet, net.openhft.chronicle.bytes.MethodReaderInterceptorReturns methodReaderInterceptorReturns, Object... handlers) Convenience constructor used by generated code.
VanillaMethodReader(MarshallableIn in, boolean ignoreDefault, WireParselet defaultParselet, FieldNumberParselet fieldNumberParselet, net.openhft.chronicle.bytes.MethodReaderInterceptorReturns methodReaderInterceptorReturns, Object[] metadataHandlers, Object... handlers) Constructor that defaults the predicate to always true.
VanillaMethodReader(MarshallableIn in, boolean ignoreDefault, WireParselet defaultParselet, FieldNumberParselet fieldNumberParselet, net.openhft.chronicle.bytes.MethodReaderInterceptorReturns methodReaderInterceptorReturns, Object[] metadataHandlers, Predicate<net.openhft.chronicle.bytes.MethodReader> predicate, Object... handlers) Primary constructor configuring parsers and interceptors.
VanillaMethodReader(MarshallableIn in, boolean ignoreDefault, WireParselet defaultParselet, net.openhft.chronicle.bytes.MethodReaderInterceptorReturns methodReaderInterceptorReturns, Object[] metadataHandlers, Object... handlers) Convenience constructor used by generated code.

Method Summary

Modifier and Type	Method and Description
void	addParseletForMethod(WireParser wireParser, Object target, Object[] contextHolder, Supplier contextSupplier, @NotNull Method method) Register a zero argument method with wireParser.
void	addParseletForMethod(WireParser wireParser, Object target, Object[] contextHolder, Supplier contextSupplier, @NotNull Method method, @NotNull Class[] parameterTypes) Registers a method with multiple arguments with the provided WireParser.
void	addParseletForMethod(WireParser wireParser, Object target, Object[] contextHolder, Supplier contextSupplier, @NotNull Method method, @NotNull Class[] parameterTypes, MethodFilterOnFirstArg methodFilterOnFirstArg) Registers a method with multiple arguments with the provided WireParser, applying a filter on the first argument.
void	addParseletForMethod(WireParser wireParser, Object target, Object[] contextHolder, Supplier contextSupplier, @NotNull Method method, Class<?> parameterType) Registers a method with the provided WireParser, enabling parsing of wire messages to trigger method invocations.
void	close()
@NotNull VanillaMethodReader	closeIn(boolean closeIn) Control whether close() also closes the input.
protected @NotNull MethodWireKey	createWireKey(@NotNull Method method, String name) Creates a MethodWireKey for a given method.
protected Object	invoke(Object target, @NotNull Method method, Object[] args) Invokes a method on an object with the provided arguments.
boolean	isClosed()
static void	logMessage(@NotNull CharSequence eventName, @NotNull ValueIn valueIn) Write a debug log entry for the incoming event if the debug mode is enabled..
net.openhft.chronicle.bytes.MethodReaderInterceptorReturns	methodReaderInterceptorReturns() Return the configured MethodReaderInterceptorReturns if any.
boolean	readOne() Read and dispatch a single message.
void	throwExceptionIfClosed() Throw IllegalStateException if this reader has been closed.

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

closeQuietly, closeQuietly

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

isClosing

Field Detail

DEBUG_ENABLED

public static final boolean DEBUG_ENABLED

Flag to enable debug logging of messages being read. Controlled by the system property wire.mr.debug. When true, messages are logged via Jvm.debug() and performance may suffer.

Constructor Detail

VanillaMethodReader

@UsedViaReflection
public VanillaMethodReader(MarshallableIn in,
                                              boolean ignoreDefault,
                                              WireParselet defaultParselet,
                                              net.openhft.chronicle.bytes.MethodReaderInterceptorReturns methodReaderInterceptorReturns,
                                              Object[] metadataHandlers,
                                              @NotNull
                                              Object... handlers)

Convenience constructor used by generated code.

Parameters:

in - source of wire messages

ignoreDefault - if true default interface methods are skipped

defaultParselet - parselet for unknown events

methodReaderInterceptorReturns - optional interceptor

metadataHandlers - handlers for metadata messages

handlers - handler instances for data messages

VanillaMethodReader

@UsedViaReflection
public VanillaMethodReader(MarshallableIn in,
                                              boolean ignoreDefault,
                                              WireParselet defaultParselet,
                                              FieldNumberParselet fieldNumberParselet,
                                              net.openhft.chronicle.bytes.MethodReaderInterceptorReturns methodReaderInterceptorReturns,
                                              @NotNull
                                              Object... handlers)

Convenience constructor used by generated code.

Parameters:

in - source of wire messages

ignoreDefault - if true default interface methods are skipped

defaultParselet - parselet for unknown events

fieldNumberParselet - parselet for numeric ids

methodReaderInterceptorReturns - optional interceptor

handlers - handler instances for data messages

VanillaMethodReader

public VanillaMethodReader(MarshallableIn in,
                           boolean ignoreDefault,
                           WireParselet defaultParselet,
                           FieldNumberParselet fieldNumberParselet,
                           net.openhft.chronicle.bytes.MethodReaderInterceptorReturns methodReaderInterceptorReturns,
                           Object[] metadataHandlers,
                           @NotNull
                           Object... handlers)

Constructor that defaults the predicate to always true. It ultimately calls the primary constructor.

Parameters:

in - source of wire messages

ignoreDefault - if true default interface methods are skipped

defaultParselet - parselet for unknown events

fieldNumberParselet - parselet for numeric ids

methodReaderInterceptorReturns - optional interceptor

metadataHandlers - handlers for metadata messages

handlers - handler instances for data messages

VanillaMethodReader

public VanillaMethodReader(MarshallableIn in,
                           boolean ignoreDefault,
                           WireParselet defaultParselet,
                           FieldNumberParselet fieldNumberParselet,
                           net.openhft.chronicle.bytes.MethodReaderInterceptorReturns methodReaderInterceptorReturns,
                           Object[] metadataHandlers,
                           Predicate<net.openhft.chronicle.bytes.MethodReader> predicate,
                           @NotNull
                           Object... handlers)

Primary constructor configuring parsers and interceptors.

Parameters:

in - source of wire messages

ignoreDefault - if true default interface methods are skipped

defaultParselet - parselet for unknown events

fieldNumberParselet - parselet for numeric ids

methodReaderInterceptorReturns - optional interceptor

metadataHandlers - handlers for metadata messages

predicate - predicate controlling readOne execution

handlers - handler instances for data messages

Method Detail

logMessage

public static void logMessage(@NotNull
                              @NotNull CharSequence eventName,
                              @NotNull
                              @NotNull ValueIn valueIn)

Write a debug log entry for the incoming event if the debug mode is enabled..

closeIn

@NotNull
public @NotNull VanillaMethodReader closeIn(boolean closeIn)

Control whether close() also closes the input.

Specified by:

closeIn in interface net.openhft.chronicle.bytes.MethodReader

throwExceptionIfClosed

public void throwExceptionIfClosed()

Throw IllegalStateException if this reader has been closed.

addParseletForMethod

public void addParseletForMethod(WireParser wireParser,
                                 Object target,
                                 Object[] contextHolder,
                                 Supplier contextSupplier,
                                 @NotNull
                                 @NotNull Method method,
                                 Class<?> parameterType)

Registers a method with the provided WireParser, enabling parsing of wire messages to trigger method invocations. The method is made accessible, and various checks and optimizations are performed based on the parameter type of the method to determine the most efficient way to handle parsing and invocation.

Parameters:

wireParser - The WireParser to which the method will be registered

target - The object on which the method should be invoked

contextHolder - The current context for method invocation

contextSupplier - Supplies the context for method invocation

method - The method to be registered

parameterType - The parameter type of the method being registered

Throws:

IllegalStateException - if the VanillaMethodReader is closed

addParseletForMethod

public void addParseletForMethod(WireParser wireParser,
                                 Object target,
                                 Object[] contextHolder,
                                 Supplier contextSupplier,
                                 @NotNull
                                 @NotNull Method method)

Register a zero argument method with wireParser.

createWireKey

@NotNull
protected @NotNull MethodWireKey createWireKey(@NotNull
                                                        @NotNull Method method,
                                                        String name)

Creates a MethodWireKey for a given method. This key is used for method registration and matching during parsing. If the method has a MethodId annotation, the key will be based on the annotation's value, otherwise, it will be based on the method's name's hash code.

Parameters:

method - The method for which the key is being generated

name - The name of the method

Returns:

A MethodWireKey uniquely representing the method

addParseletForMethod

public void addParseletForMethod(WireParser wireParser,
                                 Object target,
                                 Object[] contextHolder,
                                 Supplier contextSupplier,
                                 @NotNull
                                 @NotNull Method method,
                                 @NotNull
                                 @NotNull Class[] parameterTypes)

Registers a method with multiple arguments with the provided WireParser. The method's arguments are read from the wire message using a sequence reader, which ensures each argument is correctly parsed and matched to its corresponding parameter type.

Parameters:

wireParser - The WireParser to which the method will be registered

target - The object on which the method should be invoked

contextHolder - The current context for method invocation

contextSupplier - Supplies the context for method invocation

method - The method to be registered

parameterTypes - The array of parameter types for the method

Throws:

IllegalStateException - if the VanillaMethodReader is closed

addParseletForMethod

public void addParseletForMethod(WireParser wireParser,
                                 Object target,
                                 Object[] contextHolder,
                                 Supplier contextSupplier,
                                 @NotNull
                                 @NotNull Method method,
                                 @NotNull
                                 @NotNull Class[] parameterTypes,
                                 MethodFilterOnFirstArg methodFilterOnFirstArg)

Registers a method with multiple arguments with the provided WireParser, applying a filter on the first argument. If the filter determines that the method should be ignored based on its first argument, the method will not be executed and subsequent arguments will be skipped.

Parameters:

wireParser - The WireParser to which the method will be registered

target - The object on which the method should be invoked

contextHolder - The current context for method invocation

contextSupplier - Supplies the context for method invocation

method - The method to be registered

parameterTypes - The array of parameter types for the method

methodFilterOnFirstArg - The filter that decides if the method should be ignored based on its first argument

Throws:

IllegalStateException - If the VanillaMethodReader is closed

invoke

protected Object invoke(Object target,
                        @NotNull
                        @NotNull Method method,
                        Object[] args)
                 throws net.openhft.chronicle.core.util.InvocationTargetRuntimeException

Invokes a method on an object with the provided arguments. If an interceptor is provided, it will use the interceptor to invoke the method. If any exceptions are encountered during the invocation, appropriate warnings or exceptions are raised.

Parameters:

target - The object on which to invoke the method

method - The method to invoke

args - The arguments to pass to the method

Returns:

The result of the method invocation

Throws:

net.openhft.chronicle.core.util.InvocationTargetRuntimeException - if the invoked method itself throws an exception

readOne

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

Read and dispatch a single message.

Specified by:

readOne in interface net.openhft.chronicle.bytes.MethodReader

Throws:

net.openhft.chronicle.core.util.InvocationTargetRuntimeException

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

isClosed

public boolean isClosed()

Specified by:

isClosed in interface net.openhft.chronicle.core.io.QueryCloseable

methodReaderInterceptorReturns

public net.openhft.chronicle.bytes.MethodReaderInterceptorReturns methodReaderInterceptorReturns()

Return the configured MethodReaderInterceptorReturns if any.

Specified by:

methodReaderInterceptorReturns in interface net.openhft.chronicle.bytes.MethodReader