net.openhft.chronicle.wire.channel

Interface ChannelHandler

All Superinterfaces:

ChannelHeader, net.openhft.chronicle.bytes.CommonMarshallable, Marshallable, ReadMarshallable, net.openhft.chronicle.core.io.Resettable, WriteMarshallable, WriteValue

All Known Implementing Classes:

AbstractHandler, EchoHandler, ErrorReplyHandler, GatewayHandler, ReplyingHandler

public interface ChannelHandler
extends ChannelHeader

This interface represents a channel handler that performs various channel-related operations such as executing actions within a context, handling responses, and configuring channel settings. The ChannelHandler is passed from the client to the gateway or set by the gateway based on context.

Field Summary

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

EMPTY

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

DISCARD

Method Summary

Modifier and Type	Method and Description
ChronicleChannel	asInternalChannel(ChronicleContext context, ChronicleChannelCfg channelCfg) Converts the current ChannelHandler to an internal channel using the provided context and channel configuration.
Boolean	buffered() Indicates whether the handler supports buffering.
default boolean	closeWhenRunEnds() Determines whether the ChronicleChannel should be closed when the run method ends.
default boolean	recordHistory()
default ChannelHeader	responseHeader(ChronicleContext context) Provides a response header to send back to the client.
void	run(ChronicleContext context, ChronicleChannel channel) Executes actions within the provided context and channel.

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

sessionName, sessionName, systemContext, systemContext

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

$equals, $fieldInfoMap, $fieldInfos, $hashCode, $toString, className, copyTo, deepCopy, fromFile, fromFile, fromString, fromString, fromString, getField, getLongField, mergeToMap, readMarshallable, reset, setField, setLongField, streamFromFile, streamFromFile, writeMarshallable

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

binaryLengthLength, writeValue

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

unexpectedField

Methods inherited from interface net.openhft.chronicle.bytes.CommonMarshallable

usesSelfDescribingMessage

Method Detail

responseHeader

default ChannelHeader responseHeader(ChronicleContext context)

Provides a response header to send back to the client. Default implementation returns an OkHeader instance.

Parameters:

context - the ChronicleContext within which the response header is needed

Returns:

a ChannelHeader object that represents the response header

run

void run(ChronicleContext context,
         ChronicleChannel channel)
  throws net.openhft.chronicle.core.io.ClosedIORuntimeException,
         net.openhft.chronicle.core.io.InvalidMarshallableException

Executes actions within the provided context and channel.

Parameters:

context - the ChronicleContext within which actions will be executed

channel - the ChronicleChannel within which actions will be executed

Throws:

net.openhft.chronicle.core.io.ClosedIORuntimeException - if an I/O error occurs

net.openhft.chronicle.core.io.InvalidMarshallableException - if a Marshallable object is invalid

closeWhenRunEnds

default boolean closeWhenRunEnds()

Determines whether the ChronicleChannel should be closed when the run method ends. If false, the channel will continue to be open after the run method ends, e.g., a subscribe-only channel.

Returns:

true if the channel should be closed when the run method ends, false otherwise

asInternalChannel

ChronicleChannel asInternalChannel(ChronicleContext context,
                                   ChronicleChannelCfg channelCfg)

Converts the current ChannelHandler to an internal channel using the provided context and channel configuration.

Parameters:

context - the ChronicleContext within which the internal channel is created

channelCfg - the ChronicleChannelCfg used to configure the new internal channel

Returns:

a new ChronicleChannel instance

buffered

Boolean buffered()

Indicates whether the handler supports buffering.

Returns:

a Boolean value that indicates if buffering is supported, null if not specified

recordHistory

default boolean recordHistory()

Returns:

whether writers to this channel should include the history in the output