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

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()
default Runnable	eventHandlerAsRunnable(Object eventHandler) Reading all events and call the same method on the event handler
ChannelHeader	headerIn()
ChannelHeader	headerOut()
long	lastTestMessage()
static ChronicleChannel	newChannel(SocketRegistry socketRegistry, ChronicleChannelCfg channelCfg, ChannelHeader headerOut)
default <T> T	readOne(StringBuilder eventType, Class<T> expectedType) Read one event and return a value
void	testMessage(long now) Send a test message so the caller can wait for the 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)

channelCfg

ChronicleChannelCfg channelCfg()

headerOut

ChannelHeader headerOut()

headerIn

ChannelHeader headerIn()

readOne

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

Read one event and return a value

Parameters:

eventType - of the event read

Returns:

any data transfer object

Throws:

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

eventHandlerAsRunnable

default Runnable eventHandlerAsRunnable(Object eventHandler)

Reading all events and call the same method on the event handler

Parameters:

eventHandler - to handle events

Returns:

a Runnable that can be passed to a Thread or ExecutorService

testMessage

void testMessage(long now)

Send a test message so the caller can wait for the response via lastTestMessage()

Parameters:

now - a monotonically increasing timestamp

lastTestMessage

long lastTestMessage()

Returns:

the highest timestamp received