net.openhft.chronicle.wire.channel.echo

Class EchoHandler

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<EchoHandler>

net.openhft.chronicle.wire.channel.echo.EchoHandler

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

public class EchoHandler
extends AbstractHandler<EchoHandler>

An implementation of a channel handler that primarily echoes back any incoming data. The handler extends AbstractHandler, and implements the `run` and `asInternalChannel` methods for specific behavior.

This handler acquires an AffinityLock before running, and releases it after the ChronicleChannel is closed. While the channel is open, it continuously reads incoming data, echoing it back to the sender.

When there is no data available, it invokes the Pauser to pause execution, reducing the CPU usage when idle. If data is available, it resets the pauser to wake up immediately the next time it checks for data.

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

Method Summary

Modifier and Type	Method and Description
ChronicleChannel	asInternalChannel(ChronicleContext context, ChronicleChannelCfg channelCfg) Returns an EchoChannel as the internal channel for this handler.
void	run(ChronicleContext context, ChronicleChannel channel) Executes the main logic of this EchoHandler, which continuously reads incoming data from the provided channel and echoes it back to the sender.

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, responseHeader

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

EchoHandler

public EchoHandler()

Method Detail

run

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

Executes the main logic of this EchoHandler, which continuously reads incoming data from the provided channel and echoes it back to the sender.

Parameters:

context - the ChronicleContext in which this handler operates

channel - the ChronicleChannel from which to read the data

Throws:

net.openhft.chronicle.core.io.ClosedIORuntimeException - if the channel is closed unexpectedly

net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an issue while processing the data

asInternalChannel

public ChronicleChannel asInternalChannel(ChronicleContext context,
                                          ChronicleChannelCfg channelCfg)

Returns an EchoChannel as the internal channel for this handler.

Parameters:

context - the ChronicleContext in which this handler operates

channelCfg - the ChronicleChannelCfg that configures the channel

Returns:

a new EchoChannel instance