net.openhft.chronicle.wire.channel

Interface ChannelHeader

All Superinterfaces:

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

All Known Subinterfaces:

ChannelHandler

All Known Implementing Classes:

AbstractHandler, AbstractHeader, EchoHandler, ErrorHeader, ErrorReplyHandler, GatewayHandler, OkHeader, RedirectHeader, ReplyHeader, ReplyingHandler

public interface ChannelHeader
extends Marshallable

ChannelHeader represents the metadata of a ChronicleChannel. It maintains a system context and a session name for a channel, facilitating system-specific and session-specific configurations.

This interface extends Marshallable, making it possible for a ChannelHeader instance to be marshalled and unmarshalled for communication over a ChronicleChannel.

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
String	sessionName() Fetches the session name of the channel.
ChannelHeader	sessionName(String sessionName) Assigns a new session name to the channel.
SystemContext	systemContext() Fetches the associated system context of the channel.
ChannelHeader	systemContext(SystemContext systemContext) Assigns a new system context to the channel.

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

systemContext

SystemContext systemContext()

Fetches the associated system context of the channel.

Returns:

The SystemContext object representing the system context of the channel.

systemContext

ChannelHeader systemContext(SystemContext systemContext)

Assigns a new system context to the channel.

Parameters:

systemContext - The new SystemContext object to be set as the system context.

Returns:

The current ChannelHeader instance, allowing for method chaining.

sessionName

String sessionName()

Fetches the session name of the channel.

Returns:

The session name of the channel as a String.

sessionName

ChannelHeader sessionName(String sessionName)

Assigns a new session name to the channel.

Parameters:

sessionName - The new session name to be assigned to the channel.

Returns:

The current ChannelHeader instance, allowing for method chaining.