Class PingPayload

Namespace

NLightning.Bolts.BOLT1.Payloads

Assembly

NLightning.Bolts.dll

The ping payload.

public class PingPayload : IMessagePayload

Inheritance

object

PingPayload

Implements

IMessagePayload

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The ping payload is used to check if the other party is still alive.

Constructors

PingPayload()

public PingPayload()

Properties

BytesLength

The number of bytes to ignore.

public ushort BytesLength { get; }

Property Value

ushort

Ignored

The ignored bytes.

public byte[] Ignored { get; }

Property Value

byte[]

NumPongBytes

The number of bytes to send in the pong message.

public ushort NumPongBytes { get; }

Property Value

ushort

Methods

DeserializeAsync(Stream)

Deserialize a PingPayload from a stream.

public static Task<PingPayload> DeserializeAsync(Stream stream)

Parameters

stream Stream

The stream to deserialize from.

Returns

Task<PingPayload>

The deserialized PingPayload.

Exceptions

PayloadSerializationException

Error deserializing Payload

SerializeAsync(Stream)

Serializes the message payload to a stream.

public Task SerializeAsync(Stream stream)

Parameters

stream Stream

The stream to serialize to.

Returns

Task

A task that represents the asynchronous operation.

See Also

PingMessage