net.openhft.chronicle.wire.channel.impl

Class BufferedChronicleChannel

java.lang.Object

net.openhft.chronicle.wire.channel.impl.DelegateChronicleChannel

net.openhft.chronicle.wire.channel.impl.BufferedChronicleChannel

All Implemented Interfaces:

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

public class BufferedChronicleChannel
extends DelegateChronicleChannel

Field Summary

Fields inherited from class net.openhft.chronicle.wire.channel.impl.DelegateChronicleChannel

channel

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

MARSHALLABLE_IN_INTERN_SIZE

Constructor Summary

Constructors

Constructor and Description
BufferedChronicleChannel(TCPChronicleChannel channel, net.openhft.chronicle.threads.Pauser pauser)

Method Summary

Modifier and Type	Method and Description
WireOut	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.
void	close()
EventPoller	eventPoller() Retrieves the EventPoller instance associated with this channel.
BufferedChronicleChannel	eventPoller(EventPoller eventPoller) Associates a given EventPoller instance with this channel.
void	releaseProducer() Releases the producer instance previously acquired with acquireProducer().
DocumentContext	writingDocument(boolean metaData) Start a new DocumentContext, must always call close() when done.

Methods inherited from class net.openhft.chronicle.wire.channel.impl.DelegateChronicleChannel

bufferSize, channelCfg, headerIn, headerInToUse, headerOut, isClosed, lastTestMessage, readingDocument, recordHistory, supportsEventPoller, testMessage

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

closeQuietly, closeQuietly

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

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

Constructor Detail

BufferedChronicleChannel

public BufferedChronicleChannel(TCPChronicleChannel channel,
                                net.openhft.chronicle.threads.Pauser pauser)

Method Detail

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

Overrides:

eventPoller in class DelegateChronicleChannel

Returns:

the EventPoller instance associated with this channel.

eventPoller

public BufferedChronicleChannel 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

Overrides:

eventPoller in class DelegateChronicleChannel

Parameters:

eventPoller - the EventPoller instance to associate with this channel.

Returns:

this channel instance, allowing for method chaining.

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

Overrides:

writingDocument in class DelegateChronicleChannel

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

Overrides:

acquireWritingDocument in class DelegateChronicleChannel

Throws:

UnrecoverableTimeoutException

acquireProducer

public WireOut 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

Overrides:

acquireProducer in class DelegateChronicleChannel

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

Overrides:

releaseProducer in class DelegateChronicleChannel

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class DelegateChronicleChannel