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

This is the AbstractGeneratedMethodReader class implementing the MethodReader interface. It serves as a base class for generated method readers, providing foundational functionality and utility methods to facilitate method reading.

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) Constructs a new AbstractGeneratedMethodReader with the provided input interface and a debug logging parselet.

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()
net.openhft.chronicle.bytes.MethodReader	closeIn(boolean closeIn)
void	historyConsumer(Consumer<MessageHistory> historyConsumer) Sets a consumer for processing message history.
boolean	isClosed()
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()
AbstractGeneratedMethodReader	predicate(Predicate<net.openhft.chronicle.bytes.MethodReader> predicate) Sets a predicate to be used by the method reader.
boolean	readOne()
MethodReaderStatus	readOne0(DocumentContext context) Reads the content based on the provided document context.
protected abstract MethodReaderStatus	readOneGenerated(WireIn wireIn) Reads call name and arguments from the wire and performs invocation on a target object instance.
protected abstract MethodReaderStatus	readOneMetaGenerated(WireIn wireIn)
protected boolean	restIgnored() Determines if the rest of the wire data should be ignored.
void	scanning(boolean scanning) Sets the scanning state.
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)

Constructs a new AbstractGeneratedMethodReader with the provided input interface and a debug logging parselet.

Parameters:

in - The input interface for marshallable data

debugLoggingParselet - The parselet used for debugging and logging

Method Detail

predicate

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

Sets a predicate to be used by the method reader.

Parameters:

predicate - The predicate for filtering

Returns:

The current instance of the AbstractGeneratedMethodReader class

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 for processing message history. This consumer is invoked if the next message is for a different queue and the history message isn't written to the output queue. It ensures that the LAST_WRITTEN mechanism works even when no output is present for a given message.

Parameters:

historyConsumer - The consumer for processing message history

readOneGenerated

protected abstract MethodReaderStatus readOneGenerated(WireIn wireIn)

Reads call name and arguments from the wire and performs invocation on a target object instance. The implementation of this method is generated at runtime, see GenerateMethodReader.

Parameters:

wireIn - Data input.

Returns:

MethodReaderStatus.

readOneMetaGenerated

protected abstract MethodReaderStatus readOneMetaGenerated(WireIn wireIn)

readOne0

public MethodReaderStatus readOne0(DocumentContext context)

Reads the content based on the provided document context.

Parameters:

context - Reading document context.

Returns:

KNOWN if the read event is known, UNKNOWN if the event is not recognized, or EMPTY if no content is present.

restIgnored

protected boolean restIgnored()

Determines if the rest of the wire data should be ignored.

Returns:

true if the rest should be ignored, false otherwise. Default implementation returns false.

readOne

public boolean readOne()

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

Specified by:

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

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

closeIn

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

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 the scanning state.

Parameters:

scanning - The desired state of scanning. True to indicate scanning, false otherwise.