net.openhft.chronicle.wire.channel.echo.internal

Class EchoChannel

java.lang.Object

net.openhft.chronicle.core.io.SimpleCloseable

net.openhft.chronicle.wire.channel.echo.internal.EchoChannel

All Implemented Interfaces:

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

public class EchoChannel
extends net.openhft.chronicle.core.io.SimpleCloseable
implements ChronicleChannel

Field Summary

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

MARSHALLABLE_IN_INTERN_SIZE

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT, TMP

Constructor Summary

Constructors

Constructor and Description
EchoChannel(ChronicleChannelCfg channelCfg)

Method Summary

Modifier and Type	Method and Description
DocumentContext	acquireWritingDocument(boolean metaData) Start or reuse an existing a DocumentContext, optionally call close() when done.
ChronicleChannelCfg	channelCfg() Retrieves the configuration of the channel.
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.
DocumentContext	readingDocument()
void	testMessage(long now) Sends a test message using a monotonically increasing timestamp, enabling the caller to wait for a response via lastTestMessage().
DocumentContext	writingDocument(boolean metaData) Start a new DocumentContext, must always call close() when done.

Methods inherited from class net.openhft.chronicle.core.io.SimpleCloseable

close, isClosed, performClose

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.wire.channel.ChronicleChannel

eventHandlerAsRunnable, newChannel, readOne

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

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

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

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

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

referenceId, referenceName, temporary

Methods inherited from interface net.openhft.chronicle.core.io.ManagedCloseable

createdHere, throwExceptionIfClosed, warnAndCloseIfNotClosed

Constructor Detail

EchoChannel

public EchoChannel(ChronicleChannelCfg channelCfg)

Method Detail

channelCfg

public ChronicleChannelCfg channelCfg()

Description copied from interface: ChronicleChannel

Retrieves the configuration of the channel.

Specified by:

channelCfg in interface ChronicleChannel

Returns:

the ChronicleChannelCfg instance representing the channel configuration

headerOut

public ChannelHeader headerOut()

Description copied from interface: ChronicleChannel

Retrieves the header for outgoing messages.

Specified by:

headerOut in interface ChronicleChannel

Returns:

the ChannelHeader instance representing the header for outgoing messages

headerIn

public ChannelHeader headerIn()

Description copied from interface: ChronicleChannel

Retrieves the header for incoming messages.

Specified by:

headerIn in interface ChronicleChannel

Returns:

the ChannelHeader instance representing the header for incoming messages

testMessage

public void testMessage(long now)

Description copied from interface: ChronicleChannel

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

Specified by:

testMessage in interface ChronicleChannel

Parameters:

now - a monotonically increasing timestamp

lastTestMessage

public long lastTestMessage()

Description copied from interface: ChronicleChannel

Retrieves the highest timestamp received from the test messages.

Specified by:

lastTestMessage in interface ChronicleChannel

Returns:

the highest timestamp received as a long

readingDocument

public DocumentContext readingDocument()

Specified by:

readingDocument in interface MarshallableIn

writingDocument

public DocumentContext writingDocument(boolean metaData)
                                throws UnrecoverableTimeoutException

Description copied from interface: MarshallableOut

Start a new DocumentContext, must always call close() when done.

Specified by:

writingDocument in interface DocumentWritten

Specified by:

writingDocument in interface MarshallableOut

Throws:

UnrecoverableTimeoutException

acquireWritingDocument

public DocumentContext acquireWritingDocument(boolean metaData)
                                       throws UnrecoverableTimeoutException

Description copied from interface: MarshallableOut

Start or reuse an existing a DocumentContext, optionally call close() when done.

Specified by:

acquireWritingDocument in interface DocumentWritten

Specified by:

acquireWritingDocument in interface MarshallableOut

Throws:

UnrecoverableTimeoutException