Class ErrorMessage

Namespace

NLightning.Bolts.BOLT1.Messages

Assembly

NLightning.Bolts.dll

Represents an error message.

public sealed class ErrorMessage : BaseMessage, IMessage

Inheritance

object

BaseMessage

ErrorMessage

Implements

IMessage

Inherited Members

BaseMessage.Type

BaseMessage.Extension

BaseMessage.SerializeAsync(Stream)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

An error message is used to communicate an error to the other party. The message type is 17.

Constructors

ErrorMessage(ErrorPayload)

Represents an error message.

public ErrorMessage(ErrorPayload payload)

Parameters

payload ErrorPayload

The error payload.

Remarks

An error message is used to communicate an error to the other party. The message type is 17.

Properties

Payload

The payload of the message.

public ErrorPayload Payload { get; }

Property Value

ErrorPayload

Methods

DeserializeAsync(Stream)

Deserialize an ErrorMessage from a stream.

public static Task<ErrorMessage> DeserializeAsync(Stream stream)

Parameters

stream Stream

The stream to deserialize from.

Returns

Task<ErrorMessage>

The deserialized ErrorMessage.

Exceptions

MessageSerializationException

Error deserializing ErrorMessage