net.openhft.chronicle.wire.channel.impl

Class TCPChronicleChannel

java.lang.Object

net.openhft.chronicle.core.io.SimpleCloseable

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, ChronicleChannel, InternalChronicleChannel, DocumentWritten, MarshallableIn, MarshallableOut

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

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
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()
DocumentContext	acquireWritingDocument(boolean metaData) Start or reuse an existing a DocumentContext, optionally call close() when done.
int	bufferSize()
ChronicleChannelCfg	channelCfg()
ChronicleChannelCfg	connectionCfg()
EventPoller	eventPoller()
ChronicleChannel	eventPoller(EventPoller eventPoller) Set an EventPoller to include in any background processing.
ChannelHeader	headerIn()
ChannelHeader	headerInToUse() The header in to use based on the acceptors replacement rules.
ChannelHeader	headerOut()
long	lastTestMessage()
protected void	performClose()
DocumentContext	readingDocument()
void	releaseProducer()
boolean	supportsEventPoller()
void	testMessage(long now) Send a test message so the caller can wait for the 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

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

TCPChronicleChannel

public TCPChronicleChannel(ChronicleChannelCfg channelCfg,
                           ChannelHeader headerOut,
                           SocketRegistry socketRegistry)

Initiator constructor

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

Specified by:

channelCfg in interface ChronicleChannel

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

Overrides:

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

headerOut

public ChannelHeader headerOut()

Specified by:

headerOut in interface ChronicleChannel

headerIn

public ChannelHeader headerIn()

Specified by:

headerIn in interface ChronicleChannel

headerInToUse

public ChannelHeader headerInToUse()

Description copied from interface: InternalChronicleChannel

The header in to use based on the acceptors replacement rules.

Specified by:

headerInToUse in interface InternalChronicleChannel

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

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

Specified by:

testMessage in interface ChronicleChannel

Parameters:

now - a monotonically increasing timestamp

lastTestMessage

public long lastTestMessage()

Specified by:

lastTestMessage in interface ChronicleChannel

Returns:

the highest timestamp received

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

Specified by:

supportsEventPoller in interface InternalChronicleChannel

Returns:

true if eventPollers are supported by this Channel.

eventPoller

public EventPoller eventPoller()

Specified by:

eventPoller in interface InternalChronicleChannel

Returns:

the EventPoller set

eventPoller

public ChronicleChannel eventPoller(EventPoller eventPoller)

Description copied from interface: InternalChronicleChannel

Set an EventPoller to include in any background processing.

Specified by:

eventPoller in interface InternalChronicleChannel

Parameters:

eventPoller - to use

Returns:

this

acquireProducer

public Wire acquireProducer()

Specified by:

acquireProducer in interface InternalChronicleChannel

releaseProducer

public void releaseProducer()

Specified by:

releaseProducer in interface InternalChronicleChannel

bufferSize

public int bufferSize()

Specified by:

bufferSize in interface InternalChronicleChannel