net.openhft.chronicle.wire.channel.impl

Class TCPChronicleChannel

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.wire.channel.impl.TCPChronicleChannel

All Implemented Interfaces:

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

public class TCPChronicleChannel
extends net.openhft.chronicle.core.io.AbstractCloseable
implements InternalChronicleChannel

Field Summary

Fields inherited from class net.openhft.chronicle.core.io.AbstractCloseable

closedHere, DISABLE_DISCARD_WARNING, DISABLE_THREAD_SAFETY, STRICT_DISCARD_WARNING, WARN_NS

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

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

DISABLE_SINGLE_THREADED_CHECK

Constructor Summary

Constructors

Constructor and Description
TCPChronicleChannel(ChronicleChannelCfg channelCfg, ChannelHeader headerOut, SocketRegistry socketRegistry) Initiator constructor
TCPChronicleChannel(SystemContext systemContext, ChronicleChannelCfg channelCfg, SocketChannel sc, Function<ChannelHeader,ChannelHeader> replaceInHeader, Function<ChannelHeader,ChannelHeader> replaceOutHeader) Acceptor constructor

Method Summary

Modifier and Type	Method and Description
Wire	acquireProducer() Retrieves a producer instance associated with this channel.
DocumentContext	acquireWritingDocument(boolean metaData) Start or reuse an existing a DocumentContext, optionally call close() when done.
int	bufferSize() Returns the size of the buffer used by this channel.
ChronicleChannelCfg	channelCfg() Retrieves the configuration of the channel.
ChronicleChannelCfg	connectionCfg()
EventPoller	eventPoller() Retrieves the EventPoller instance associated with this channel.
ChronicleChannel	eventPoller(EventPoller eventPoller) Associates a given EventPoller instance with this channel.
ChannelHeader	headerIn() Retrieves the header for incoming messages.
ChannelHeader	headerInToUse() Returns the ChannelHeader to be used for incoming data.
ChannelHeader	headerOut() Retrieves the header for outgoing messages.
long	lastTestMessage() Retrieves the highest timestamp received from the test messages.
protected void	performClose()
DocumentContext	readingDocument()
boolean	recordHistory()
void	releaseProducer() Releases the producer instance previously acquired with acquireProducer().
boolean	supportsEventPoller() Determines if the current channel supports the EventPoller mechanism for polling events.
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.AbstractCloseable

assertCloseable, assertCloseablesClosed, clearUsedByThread, close, createdHere, disableCloseableTracing, disableThreadSafetyCheck, disableThreadSafetyCheck, enableCloseableTracing, gcAndWaitForCloseablesToClose, isClosed, isClosing, isInUserThread, referenceId, resetUsedByThread, shouldPerformCloseInBackground, shouldWaitForClosed, singleThreadedCheckDisabled, singleThreadedCheckDisabled, singleThreadedCheckReset, threadSafetyCheck, throwExceptionIfClosed, throwExceptionIfClosedInSetter, toString, unmonitor, waitForCloseablesToClose, waitForClosed, warnAndCloseIfNotClosed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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, 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

referenceName, temporary

Constructor Detail

TCPChronicleChannel

public TCPChronicleChannel(ChronicleChannelCfg channelCfg,
                           ChannelHeader headerOut,
                           SocketRegistry socketRegistry)
                    throws net.openhft.chronicle.core.io.InvalidMarshallableException

Initiator constructor

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

TCPChronicleChannel

public TCPChronicleChannel(SystemContext systemContext,
                           ChronicleChannelCfg channelCfg,
                           SocketChannel sc,
                           Function<ChannelHeader,ChannelHeader> replaceInHeader,
                           Function<ChannelHeader,ChannelHeader> replaceOutHeader)

Acceptor constructor

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

readingDocument

public DocumentContext readingDocument()
                                throws net.openhft.chronicle.core.io.ClosedIORuntimeException

Specified by:

readingDocument in interface MarshallableIn

Throws:

net.openhft.chronicle.core.io.ClosedIORuntimeException

performClose

protected void performClose()

Specified by:

performClose in class net.openhft.chronicle.core.io.AbstractCloseable

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

headerInToUse

public ChannelHeader headerInToUse()

Description copied from interface: InternalChronicleChannel

Returns the ChannelHeader to be used for incoming data. The header is determined based on the acceptor's replacement rules.

Specified by:

headerInToUse in interface InternalChronicleChannel

Returns:

the ChannelHeader for incoming data.

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

connectionCfg

public ChronicleChannelCfg connectionCfg()

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

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

supportsEventPoller

public boolean supportsEventPoller()

Description copied from interface: InternalChronicleChannel

Determines if the current channel supports the EventPoller mechanism for polling events.

Specified by:

supportsEventPoller in interface InternalChronicleChannel

Returns:

true if event pollers are supported by this channel, false otherwise.

eventPoller

public EventPoller eventPoller()

Description copied from interface: InternalChronicleChannel

Retrieves the EventPoller instance associated with this channel. This EventPoller can be used to poll events from the channel.

Specified by:

eventPoller in interface InternalChronicleChannel

Returns:

the EventPoller instance associated with this channel.

eventPoller

public ChronicleChannel eventPoller(EventPoller eventPoller)

Description copied from interface: InternalChronicleChannel

Associates a given EventPoller instance with this channel. This EventPoller will be included in any background processing associated with the channel.

Specified by:

eventPoller in interface InternalChronicleChannel

Parameters:

eventPoller - the EventPoller instance to associate with this channel.

Returns:

this channel instance, allowing for method chaining.

acquireProducer

public Wire acquireProducer()

Description copied from interface: InternalChronicleChannel

Retrieves a producer instance associated with this channel. This producer can be used to write data to the channel.

Specified by:

acquireProducer in interface InternalChronicleChannel

Returns:

the producer instance as a WireOut object.

releaseProducer

public void releaseProducer()

Description copied from interface: InternalChronicleChannel

Releases the producer instance previously acquired with acquireProducer(). This method should be called when the producer instance is no longer needed, to free up resources.

Specified by:

releaseProducer in interface InternalChronicleChannel

bufferSize

public int bufferSize()

Description copied from interface: InternalChronicleChannel

Returns the size of the buffer used by this channel. The buffer size can impact the performance of the channel, with larger buffers typically providing better throughput at the cost of increased memory usage.

Specified by:

bufferSize in interface InternalChronicleChannel

Returns:

the size of the buffer used by this channel, in bytes.

recordHistory

public boolean recordHistory()

Specified by:

recordHistory in interface MarshallableOut

Returns:

true if this output is configured to expect the history of the message to be written to.