Class WarningMessage

Namespace

NLightning.Bolts.BOLT1.Messages

Assembly

NLightning.Bolts.dll

Represents a warning message.

public sealed class WarningMessage : BaseMessage, IMessage

Inheritance

object

BaseMessage

WarningMessage

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

A warning message is used to communicate a warning to the other party. The message type is 1.

Constructors

WarningMessage(ErrorPayload)

Represents a warning message.

public WarningMessage(ErrorPayload payload)

Parameters

payload ErrorPayload

The warning payload. ErrorPayload

Remarks

A warning message is used to communicate a warning to the other party. The message type is 1.

Properties

Payload

The payload of the message.

public ErrorPayload Payload { get; }

Property Value

ErrorPayload

Methods

DeserializeAsync(Stream)

Deserialize a WarningMessage from a stream.

public static Task<WarningMessage> DeserializeAsync(Stream stream)

Parameters

stream Stream

The stream to deserialize from.

Returns

Task<WarningMessage>

The deserialized WarningMessage.

Exceptions

MessageSerializationException

Error deserializing WarningMessage