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

This is the VanillaMethodReader class implementing the MethodReader interface. The class primarily handles reading methods from a MarshallableIn source and provides related utilities. It works with WireParselet, MethodReaderInterceptorReturns, and other constructs to facilitate the reading process.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG_ENABLED

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... objects)
VanillaMethodReader(MarshallableIn in, boolean ignoreDefault, WireParselet defaultParselet, FieldNumberParselet fieldNumberParselet, net.openhft.chronicle.bytes.MethodReaderInterceptorReturns methodReaderInterceptorReturns, Object[] metaDataHandler, Object... objects) This constructor is an overloaded version of the primary VanillaMethodReader constructor.
VanillaMethodReader(MarshallableIn in, boolean ignoreDefault, WireParselet defaultParselet, FieldNumberParselet fieldNumberParselet, net.openhft.chronicle.bytes.MethodReaderInterceptorReturns methodReaderInterceptorReturns, Object[] metaDataHandler, Predicate<net.openhft.chronicle.bytes.MethodReader> predicate, Object... objects) This is the primary constructor for the VanillaMethodReader class.
VanillaMethodReader(MarshallableIn in, boolean ignoreDefault, WireParselet defaultParselet, net.openhft.chronicle.bytes.MethodReaderInterceptorReturns methodReaderInterceptorReturns, Object[] metaDataHandler, Object... objects) Constructor for creating an instance of VanillaMethodReader with specified parameters.

Method Summary

Modifier and Type	Method and Description
void	addParseletForMethod(WireParser wireParser, Object o2, Object[] context, Supplier contextSupplier, @NotNull Method m) Registers a method with no arguments with the provided WireParser.
void	addParseletForMethod(WireParser wireParser, Object o2, Object[] context, Supplier contextSupplier, @NotNull Method m, @NotNull Class[] parameterTypes) Registers a method with multiple arguments with the provided WireParser.
void	addParseletForMethod(WireParser wireParser, Object o2, Object[] context, Supplier contextSupplier, @NotNull Method m, @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 o2, Object[] context, Supplier contextSupplier, @NotNull Method m, 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) Sets the closeIn state of the VanillaMethodReader.
protected @NotNull MethodWireKey	createWireKey(@NotNull Method m, String name) Creates a MethodWireKey for a given method.
protected Object	invoke(Object o, @NotNull Method m, Object[] args) Invokes a method on an object with the provided arguments.
boolean	isClosed()
static void	logMessage(@NotNull CharSequence s, @NotNull ValueIn v) Logs a message if the debug mode is enabled.
net.openhft.chronicle.bytes.MethodReaderInterceptorReturns	methodReaderInterceptorReturns() Retrieves the current method reader interceptor.
boolean	readOne() Reads a single message.
void	throwExceptionIfClosed() Checks if the VanillaMethodReader is 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

Constructor Detail

VanillaMethodReader

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

Constructor for creating an instance of VanillaMethodReader with specified parameters. It uses default values for certain parameters like SKIP_READABLE_BYTES and creates the instance accordingly.

Parameters:

in - The MarshallableIn source from which methods are read.

ignoreDefault - Flag to determine if defaults should be ignored.

defaultParselet - The default parselet to use.

methodReaderInterceptorReturns - The interceptor for method reading.

metaDataHandler - Metadata handler array.

objects - Varargs for additional parameters.

VanillaMethodReader

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

VanillaMethodReader

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

This constructor is an overloaded version of the primary VanillaMethodReader constructor. It initializes the reader with default predicate logic (always true) and delegates the initialization to the primary constructor.

Parameters:

in - The MarshallableIn source from which methods are read.

ignoreDefault - Flag to determine if defaults should be ignored.

defaultParselet - The default parselet to be used for parsing.

fieldNumberParselet - Custom parselet for handling field numbers.

methodReaderInterceptorReturns - Interceptor for reading methods.

metaDataHandler - Metadata handler array.

objects - Varargs for additional parameters, including custom parselets.

VanillaMethodReader

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

This is the primary constructor for the VanillaMethodReader class. It initializes the reader with a provided input source, parsing strategies, interceptors, metadata handlers, and other configurations. It supports a comprehensive configuration by accepting multiple parameters and sets up parsers accordingly.

Parameters:

in - The MarshallableIn source from which methods are read.

ignoreDefault - Flag to determine if defaults should be ignored.

defaultParselet - The default parselet to be used for parsing.

fieldNumberParselet - Custom parselet for handling field numbers.

methodReaderInterceptorReturns - Interceptor for reading methods.

metaDataHandler - Metadata handler array.

predicate - Predicate for filtering.

objects - Varargs for additional parameters, including custom parselets.

Method Detail

logMessage

public static void logMessage(@NotNull
                              @NotNull CharSequence s,
                              @NotNull
                              @NotNull ValueIn v)

Logs a message if the debug mode is enabled.

Parameters:

s - A CharSequence representing part of the message.

v - The ValueIn associated with the message.

closeIn

@NotNull
public @NotNull VanillaMethodReader closeIn(boolean closeIn)

Sets the closeIn state of the VanillaMethodReader. When closeIn is true, the reader will be automatically closed after reading, otherwise, it remains open for further operations.

Specified by:

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

Parameters:

closeIn - The new closeIn state to be set

Returns:

The current instance of the VanillaMethodReader for chaining method calls

Throws:

IllegalStateException - if the VanillaMethodReader is already closed

throwExceptionIfClosed

public void throwExceptionIfClosed()

Checks if the VanillaMethodReader is closed.

Throws:

IllegalStateException - if the VanillaMethodReader is closed

addParseletForMethod

public void addParseletForMethod(WireParser wireParser,
                                 Object o2,
                                 Object[] context,
                                 Supplier contextSupplier,
                                 @NotNull
                                 @NotNull Method m,
                                 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

o2 - The object on which the method should be invoked

context - The current context for method invocation

contextSupplier - Supplies the context for method invocation

m - 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 o2,
                                 Object[] context,
                                 Supplier contextSupplier,
                                 @NotNull
                                 @NotNull Method m)

Registers a method with no arguments with the provided WireParser. When a wire message is parsed that matches this method, the method will be invoked without arguments.

Parameters:

wireParser - The WireParser to which the method will be registered

o2 - The object on which the method should be invoked

context - The current context for method invocation

contextSupplier - Supplies the context for method invocation

m - The method to be registered

Throws:

IllegalStateException - if the VanillaMethodReader is closed

createWireKey

@NotNull
protected @NotNull MethodWireKey createWireKey(@NotNull
                                                        @NotNull Method m,
                                                        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:

m - 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 o2,
                                 Object[] context,
                                 Supplier contextSupplier,
                                 @NotNull
                                 @NotNull Method m,
                                 @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

o2 - The object on which the method should be invoked

context - The current context for method invocation

contextSupplier - Supplies the context for method invocation

m - 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 o2,
                                 Object[] context,
                                 Supplier contextSupplier,
                                 @NotNull
                                 @NotNull Method m,
                                 @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

o2 - The object on which the method should be invoked

context - The current context for method invocation

contextSupplier - Supplies the context for method invocation

m - 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 o,
                        @NotNull
                        @NotNull Method m,
                        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:

o - The object on which to invoke the method

m - 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

Reads a single message. If the message is metadata, it returns true even if it's ignored.

Specified by:

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

Returns:

true if a message was read or if metadata was ignored; false if no more data is available

Throws:

net.openhft.chronicle.core.util.InvocationTargetRuntimeException - if an exception occurs during message reading

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()

Retrieves the current method reader interceptor. The interceptor can be used to alter the behavior of method invocation.

Specified by:

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

Returns:

The current MethodReaderInterceptorReturns instance.

Throws:

IllegalStateException - if the method reader is closed.