net.openhft.chronicle.wire.channel

Class ErrorHeader

java.lang.Object

net.openhft.chronicle.wire.AbstractCommonMarshallable

net.openhft.chronicle.wire.SelfDescribingMarshallable

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

net.openhft.chronicle.wire.channel.ErrorHeader

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

public class ErrorHeader
extends AbstractHeader<ErrorHeader>

A specialized type of AbstractHeader that encapsulates an error message.

ErrorHeader instances are used to convey error information between different components of a system via a ChronicleChannel. The error message can be retrieved and modified using provided getter and setter methods.

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

Method Summary

Modifier and Type	Method and Description
String	errorMsg() Retrieves the error message encapsulated by this header.
ErrorHeader	errorMsg(String errorMsg) Sets the error message to be encapsulated by this header.

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

ErrorHeader

public ErrorHeader()

Method Detail

errorMsg

public String errorMsg()

Retrieves the error message encapsulated by this header.

Returns:

A string representing the stored error message. If no error message has been set, this may return null.

errorMsg

public ErrorHeader errorMsg(String errorMsg)

Sets the error message to be encapsulated by this header.

Parameters:

errorMsg - A string representing the error message to be stored. This could be the description of an error or an exception message.

Returns:

This ErrorHeader instance, to support fluent interface design and method chaining.