net.openhft.chronicle.wire.channel

Interface ChronicleChannel

All Superinterfaces:

AutoCloseable, Closeable, DocumentWritten, MarshallableIn, MarshallableOut, net.openhft.chronicle.core.io.QueryCloseable

All Known Subinterfaces:

InternalChronicleChannel

All Known Implementing Classes:

BufferedChronicleChannel, DelegateChronicleChannel, EchoChannel, TCPChronicleChannel

public interface ChronicleChannel
extends net.openhft.chronicle.core.io.Closeable, MarshallableOut, MarshallableIn

The ChronicleChannel interface encapsulates a communication channel that can process various data types. It extends the Closeable, MarshallableOut, and MarshallableIn interfaces, thereby supporting a wide range of I/O operations.

Field Summary

Fields inherited from interface net.openhft.chronicle.wire.MarshallableIn

MARSHALLABLE_IN_INTERN_SIZE

Method Summary

Modifier and Type	Method and Description
ChronicleChannelCfg	channelCfg() Retrieves the configuration of the channel.
default Runnable	eventHandlerAsRunnable(Object eventHandler) Creates a Runnable that reads all events from the channel and delegates them to the provided event handler.
ChannelHeader	headerIn() Retrieves the header for incoming messages.
ChannelHeader	headerOut() Retrieves the header for outgoing messages.
long	lastTestMessage() Retrieves the highest timestamp received from the test messages.
static ChronicleChannel	newChannel(SocketRegistry socketRegistry, ChronicleChannelCfg channelCfg, ChannelHeader headerOut) Creates a new instance of a ChronicleChannel.
default <T> T	readOne(StringBuilder eventType, Class<T> expectedType) Reads a single event of the expected type from the channel.
void	testMessage(long now) Sends a test message using a monotonically increasing timestamp, enabling the caller to wait for a response via lastTestMessage().

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

Methods inherited from interface net.openhft.chronicle.wire.MarshallableOut

acquireWritingDocument, builder, methodWriter, methodWriter, methodWriterBuilder, methodWriterBuilder, recordHistory, writeBytes, writeDocument, writeDocument, writeMap, writeMessage, writeMessage, writeText, writingDocument, writingDocument

Methods inherited from interface net.openhft.chronicle.wire.MarshallableIn

methodReader, methodReaderBuilder, readBytes, readBytes, readDocument, readingDocument, readMap, readText, readText

Method Detail

newChannel

static ChronicleChannel newChannel(SocketRegistry socketRegistry,
                                   ChronicleChannelCfg channelCfg,
                                   ChannelHeader headerOut)
                            throws net.openhft.chronicle.core.io.InvalidMarshallableException

Creates a new instance of a ChronicleChannel.

Parameters:

socketRegistry - the SocketRegistry for managing the socket

channelCfg - the ChronicleChannelCfg providing the configuration for the channel

headerOut - the ChannelHeader for outgoing messages

Returns:

a new ChronicleChannel instance

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an error marshalling the objects for communication

channelCfg

ChronicleChannelCfg channelCfg()

Retrieves the configuration of the channel.

Returns:

the ChronicleChannelCfg instance representing the channel configuration

headerOut

ChannelHeader headerOut()

Retrieves the header for outgoing messages.

Returns:

the ChannelHeader instance representing the header for outgoing messages

headerIn

ChannelHeader headerIn()

Retrieves the header for incoming messages.

Returns:

the ChannelHeader instance representing the header for incoming messages

readOne

default <T> T readOne(StringBuilder eventType,
                      Class<T> expectedType)
               throws net.openhft.chronicle.core.io.ClosedIORuntimeException,
                      net.openhft.chronicle.core.io.InvalidMarshallableException

Reads a single event of the expected type from the channel.

Parameters:

eventType - a StringBuilder object to append the event type

expectedType - the Class of the expected event type

Returns:

an instance of the expected type representing the read data

Throws:

net.openhft.chronicle.core.io.ClosedIORuntimeException - if this ChronicleChannel has been closed

net.openhft.chronicle.core.io.InvalidMarshallableException - if the Marshallable object fails to be read

eventHandlerAsRunnable

default Runnable eventHandlerAsRunnable(Object eventHandler)

Creates a Runnable that reads all events from the channel and delegates them to the provided event handler.

Parameters:

eventHandler - an object that handles the processed events

Returns:

a Runnable instance that can be submitted to a Thread or ExecutorService

testMessage

void testMessage(long now)

Sends a test message using a monotonically increasing timestamp, enabling the caller to wait for a response via lastTestMessage().

Parameters:

now - a monotonically increasing timestamp

lastTestMessage

long lastTestMessage()

Retrieves the highest timestamp received from the test messages.

Returns:

the highest timestamp received as a long