net.openhft.chronicle.wire.channel

Class AbstractHeader<H extends AbstractHeader<H>>

java.lang.Object

net.openhft.chronicle.wire.AbstractCommonMarshallable

net.openhft.chronicle.wire.SelfDescribingMarshallable

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

Type Parameters:

H - Type of the class that extends AbstractHeader. Used to ensure the correct type is returned by the builder methods, supporting method chaining.

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, ChannelHeader, Marshallable, ReadMarshallable, WriteMarshallable, WriteValue

Direct Known Subclasses:

AbstractHandler, ErrorHeader, OkHeader, RedirectHeader, ReplyHeader

public abstract class AbstractHeader<H extends AbstractHeader<H>>
extends SelfDescribingMarshallable
implements ChannelHeader

The AbstractHeader class serves as a foundational template for all channel header types. The class extends the SelfDescribingMarshallable and implements the ChannelHeader interface. It includes fields for a system context and a session name, providing methods to get and set these fields. This class is designed to be extended by other header types to standardize their functionality.

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

Method Summary

Modifier and Type	Method and Description
String	sessionName() Retrieves the session name associated with this header.
H	sessionName(String sessionName) Sets the session name associated with this header.
SystemContext	systemContext() Retrieves the system context associated with this header.
H	systemContext(SystemContext systemContext) Sets the system context associated with this header.

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

AbstractHeader

public AbstractHeader()

Method Detail

systemContext

public SystemContext systemContext()

Retrieves the system context associated with this header.

Specified by:

systemContext in interface ChannelHeader

Returns:

the system context as a SystemContext object. Null if no system context has been set.

systemContext

public H systemContext(SystemContext systemContext)

Sets the system context associated with this header.

Specified by:

systemContext in interface ChannelHeader

Parameters:

systemContext - the SystemContext object to set as the system context for this header.

Returns:

this instance of the header, allowing method chaining.

sessionName

public String sessionName()

Retrieves the session name associated with this header.

Specified by:

sessionName in interface ChannelHeader

Returns:

the session name as a String. Null if no session name has been set.

sessionName

public H sessionName(String sessionName)

Sets the session name associated with this header.

Specified by:

sessionName in interface ChannelHeader

Parameters:

sessionName - the String to set as the session name for this header.

Returns:

this instance of the header, allowing method chaining.