net.openhft.chronicle.wire

Class AbstractGeneratedMethodReader

java.lang.Object

net.openhft.chronicle.wire.AbstractGeneratedMethodReader

All Implemented Interfaces:

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

public abstract class AbstractGeneratedMethodReader
extends Object
implements net.openhft.chronicle.bytes.MethodReader

Abstract base class for generated method readers. Provides shared utilities and state management for the runtime generated implementations.

Common machinery for method readers generated by GenerateMethodReader. Subclasses implement readOneGenerated(WireIn) and readOneMetaGenerated(WireIn) with optimised dispatch logic.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	dataEventProcessed
protected WireParselet	debugLoggingParselet
protected MessageHistory	messageHistory
static ThreadLocal<String>	SERVICE_NAME

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

HISTORY, MESSAGE_HISTORY_METHOD_ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGeneratedMethodReader(MarshallableIn in, WireParselet debugLoggingParselet) Creates a reader for the supplied input.

Method Summary

Modifier and Type	Method and Description
protected Object	actualInvoke(Method method, Object o, Object[] objects) Invokes a given method on the provided object with the specified arguments.
protected <T> T	checkRecycle(T o) Offers a workaround to selectively disable "object recycling read" provided by ValueIn.object(Object, Class) for specific object types.
void	close() Closes this reader and optionally the underlying MarshallableIn.
net.openhft.chronicle.bytes.MethodReader	closeIn(boolean closeIn) Controls whether the underlying input is closed when this reader closes.
void	historyConsumer(Consumer<MessageHistory> historyConsumer) Sets a Consumer that receives MessageHistory objects.
boolean	isClosed() Indicates whether close() has been called.
protected static Method	lookupMethod(Class<?> clazz, String name, Class<?>... parameterTypes) A utility method that assists implementations in retrieving a method from a class.
net.openhft.chronicle.bytes.MethodReaderInterceptorReturns	methodReaderInterceptorReturns() Returns null unless overridden by generated readers that support interceptors.
AbstractGeneratedMethodReader	predicate(Predicate<net.openhft.chronicle.bytes.MethodReader> predicate) Sets a predicate that readOne() will evaluate.
boolean	readOne() Reads and dispatches a single message.
MethodReaderStatus	readOne0(DocumentContext context) Core logic for reading a single document.
protected abstract MethodReaderStatus	readOneGenerated(WireIn wireIn) Dispatches a data event read from wireIn.
protected abstract MethodReaderStatus	readOneMetaGenerated(WireIn wireIn) As readOneGenerated(WireIn) but for metadata events.
protected boolean	restIgnored() Hook for generated code to skip the remainder of a message when method chaining returns an IgnoresEverything instance.
void	scanning(boolean scanning) Sets whether this reader is in scanning mode.
void	throwExceptionIfClosed() Checks if the method reader instance has been closed and throws a ClosedIllegalStateException if it is.

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

SERVICE_NAME

public static final ThreadLocal<String> SERVICE_NAME

debugLoggingParselet

protected final WireParselet debugLoggingParselet

messageHistory

protected MessageHistory messageHistory

dataEventProcessed

protected boolean dataEventProcessed

Constructor Detail

AbstractGeneratedMethodReader

protected AbstractGeneratedMethodReader(MarshallableIn in,
                                        WireParselet debugLoggingParselet)

Creates a reader for the supplied input. If SERVICE_NAME is set the value is used to obtain a temporary history cache from TEMP_MESSAGE_HISTORY_BY_SERVICE_NAME so that services sharing a thread keep separate histories.

Parameters:

in - input providing documents

debugLoggingParselet - parselet used when debug logging is enabled

Method Detail

predicate

public AbstractGeneratedMethodReader predicate(Predicate<net.openhft.chronicle.bytes.MethodReader> predicate)

Sets a predicate that readOne() will evaluate. If the predicate returns false, no attempt is made to read a message.

Parameters:

predicate - condition to be evaluated before reading

Returns:

this reader

lookupMethod

protected static Method lookupMethod(Class<?> clazz,
                                     String name,
                                     Class<?>... parameterTypes)

A utility method that assists implementations in retrieving a method from a class. It looks up the method by its name and parameter types, making it accessible if it's private or protected.

Parameters:

clazz - The class containing the method

name - The name of the method

parameterTypes - The parameter types of the method

Returns:

The method if found, otherwise throws an AssertionError

historyConsumer

public void historyConsumer(Consumer<MessageHistory> historyConsumer)

Sets a Consumer that receives MessageHistory objects. The consumer is called from readOne0(DocumentContext) when a cached history must be written because the next message originates from another source.

Parameters:

historyConsumer - recipient of unwritten message history

readOneGenerated

protected abstract MethodReaderStatus readOneGenerated(WireIn wireIn)

Dispatches a data event read from wireIn. Implementations generated by GenerateMethodReader parse the event name, deserialize arguments and invoke the corresponding handler method.

Parameters:

wireIn - input wire

Returns:

result of the dispatch

readOneMetaGenerated

protected abstract MethodReaderStatus readOneMetaGenerated(WireIn wireIn)

As readOneGenerated(WireIn) but for metadata events.

readOne0

public MethodReaderStatus readOne0(DocumentContext context)

Core logic for reading a single document.

The method resets messageHistory with the current source and index, optionally writes any pending history via historyConsumer and then processes all data in the document using readOneGenerated(WireIn) or readOneMetaGenerated(WireIn) depending on DocumentContext.isData(). When the document contains a data event and history propagation is enabled the method may swap the history buffers using swapMessageHistoryIfDirty().

Parameters:

context - the document context being read

Returns:

the aggregated status for the document

restIgnored

protected boolean restIgnored()

Hook for generated code to skip the remainder of a message when method chaining returns an IgnoresEverything instance. The default implementation never skips.

Returns:

true if the rest of the message should be ignored

readOne

public boolean readOne()

Reads and dispatches a single message. The reader respects predicate and in scanning mode continues looping until a matching message is found or no document is present.

Specified by:

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

throwExceptionIfClosed

public void throwExceptionIfClosed()
                            throws net.openhft.chronicle.core.io.ClosedIllegalStateException

Checks if the method reader instance has been closed and throws a ClosedIllegalStateException if it is. This method is intended to guard against operations on a closed instance, ensuring that no further operations can be performed once the instance has been closed. This is particularly useful for methods that modify the state of the instance or rely on its open state to function correctly.

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - if this instance has already been closed.

methodReaderInterceptorReturns

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

Returns null unless overridden by generated readers that support interceptors.

Specified by:

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

close

public void close()

Closes this reader and optionally the underlying MarshallableIn.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

isClosed

public boolean isClosed()

Indicates whether close() has been called.

Specified by:

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

closeIn

public net.openhft.chronicle.bytes.MethodReader closeIn(boolean closeIn)

Controls whether the underlying input is closed when this reader closes.

Specified by:

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

checkRecycle

protected <T> T checkRecycle(T o)

Offers a workaround to selectively disable "object recycling read" provided by ValueIn.object(Object, Class) for specific object types. This ensures that certain objects, such as arrays and collections, are not unintentionally reused or recycled during the reading process.

Type Parameters:

T - The generic type of the object to check.

Parameters:

o - The object instance to verify and possibly recycle.

Returns:

The object itself if recycling is not applied, or null if the object is either null or an array. If the object is a collection or map, the method will clear its content and return the object.

actualInvoke

protected Object actualInvoke(Method method,
                              Object o,
                              Object[] objects)

Invokes a given method on the provided object with the specified arguments.

Parameters:

method - The method to be invoked.

o - The target object on which the method is to be invoked.

objects - The arguments to the method.

Returns:

Returns the result of the method invocation.

Throws:

RuntimeException - if the method invocation throws an exception.

scanning

public void scanning(boolean scanning)

Sets whether this reader is in scanning mode. When scanning the reader may skip metadata until a relevant message is encountered.