net.openhft.chronicle.wire.channel

Interface InternalChronicleChannel

All Superinterfaces:

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

All Known Implementing Classes:

BufferedChronicleChannel, DelegateChronicleChannel, TCPChronicleChannel

public interface InternalChronicleChannel
extends ChronicleChannel

The InternalChronicleChannel interface extends the ChronicleChannel interface and provides additional methods that support advanced functionalities within Chronicle Channels. This interface is intended for internal use within the system and its options might change in future versions, hence it should be used with caution.

Field Summary

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

MARSHALLABLE_IN_INTERN_SIZE

Method Summary

Modifier and Type	Method and Description
WireOut	acquireProducer() Retrieves a producer instance associated with this channel.
int	bufferSize() Returns the size of the buffer used by this channel.
EventPoller	eventPoller() Retrieves the EventPoller instance associated with this channel.
ChronicleChannel	eventPoller(EventPoller eventPoller) Associates a given EventPoller instance with this channel.
ChannelHeader	headerInToUse() Returns the ChannelHeader to be used for incoming data.
void	releaseProducer() Releases the producer instance previously acquired with acquireProducer().
boolean	supportsEventPoller() Determines if the current channel supports the EventPoller mechanism for polling events.

Methods inherited from interface net.openhft.chronicle.wire.channel.ChronicleChannel

channelCfg, eventHandlerAsRunnable, headerIn, headerOut, lastTestMessage, newChannel, readOne, testMessage

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

headerInToUse

ChannelHeader headerInToUse()

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

Returns:

the ChannelHeader for incoming data.

supportsEventPoller

boolean supportsEventPoller()

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

Returns:

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

eventPoller

EventPoller eventPoller()

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

Returns:

the EventPoller instance associated with this channel.

eventPoller

ChronicleChannel eventPoller(EventPoller eventPoller)

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

Parameters:

eventPoller - the EventPoller instance to associate with this channel.

Returns:

this channel instance, allowing for method chaining.

acquireProducer

WireOut acquireProducer()

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

Returns:

the producer instance as a WireOut object.

releaseProducer

void releaseProducer()

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.

bufferSize

int bufferSize()

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.

Returns:

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