net.openhft.chronicle.wire.channel

Class ReplyingHandler<H extends ReplyingHandler<H>>

java.lang.Object

net.openhft.chronicle.wire.AbstractCommonMarshallable

net.openhft.chronicle.wire.SelfDescribingMarshallable

net.openhft.chronicle.wire.channel.AbstractHeader<H>

net.openhft.chronicle.wire.channel.AbstractHandler<H>

net.openhft.chronicle.wire.channel.ReplyingHandler<H>

Type Parameters:

H - The specific subclass of ReplyingHandler, used for ensuring type correctness in fluent APIs.

All Implemented Interfaces:

net.openhft.chronicle.bytes.BytesMarshallable, net.openhft.chronicle.bytes.CommonMarshallable, net.openhft.chronicle.bytes.ReadBytesMarshallable, net.openhft.chronicle.bytes.WriteBytesMarshallable, net.openhft.chronicle.core.io.Resettable, ChannelHandler, ChannelHeader, Marshallable, ReadMarshallable, WriteMarshallable, WriteValue

Direct Known Subclasses:

ErrorReplyHandler

public abstract class ReplyingHandler<H extends ReplyingHandler<H>>
extends AbstractHandler<H>

An abstract handler that provides a mechanism for sending responses in a communication protocol. Typically, these responses could be of type OkHeader, ReplyHeader, ErrorHandler.

It extends AbstractHandler, and subclasses of this handler are expected to implement the responseHeader(ChronicleContext) method to provide a custom channel header for responses.

Field Summary

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

EMPTY

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

DISCARD

Constructor Summary

Constructors

Constructor and Description
ReplyingHandler()

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.
abstract 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 class net.openhft.chronicle.wire.channel.AbstractHandler

buffered, buffered

Methods inherited from class net.openhft.chronicle.wire.channel.AbstractHeader

sessionName, sessionName, systemContext, systemContext

Methods inherited from class net.openhft.chronicle.wire.SelfDescribingMarshallable

usesSelfDescribingMessage

Methods inherited from class net.openhft.chronicle.wire.AbstractCommonMarshallable

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

closeWhenRunEnds, recordHistory

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

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

$toString, readMarshallable, writeMarshallable

Constructor Detail

ReplyingHandler

public ReplyingHandler()

Method Detail

responseHeader

public abstract ChannelHeader responseHeader(ChronicleContext context)

Description copied from interface: ChannelHandler

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

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

Description copied from interface: ChannelHandler

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

asInternalChannel

public ChronicleChannel asInternalChannel(ChronicleContext context,
                                          ChronicleChannelCfg channelCfg)

Description copied from interface: ChannelHandler

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