Class StunMessage

Inheritance

Object

StunMessage

AllocateErrorResponse

AllocateRequest

AllocateSuccessResponse

BindingRequest

BindingSuccessResponse

ConnectionAttempt

ConnectionBindRequest

ConnectionBindSuccessResponse

ConnectRequest

ConnectSuccessResponse

CreatePermissionErrorResponse

CreatePermissionRequest

CreatePermissionSuccessResponse

RefreshErrorResponse

RefreshRequest

RefreshSuccessResponse

Namespace: Libplanet.Stun.Messages

Assembly: Libplanet.Stun.dll

Syntax

public abstract class StunMessage : object

Constructors

StunMessage()

Declaration

protected StunMessage()

Properties

Attributes

A list of Attribute of STUN packet.

Declaration

protected IEnumerable<Attribute> Attributes { get; set; }

Property Value

Type	Description
IEnumerable<Attribute>

Class

A StunMessage.MessageClass of STUN packet.

Declaration

public abstract StunMessage.MessageClass Class { get; }

Property Value

Type	Description
StunMessage.MessageClass

Method

A StunMessage.MessageMethod of STUN packet.

Declaration

public abstract StunMessage.MessageMethod Method { get; }

Property Value

Type	Description
StunMessage.MessageMethod

TransactionId

A 96-bit length identifier, used to uniquely identify STUN transactions.

Declaration

public byte[] TransactionId { get; }

Property Value

Type	Description
Byte[]

Methods

Encode(IStunContext)

Declaration

public byte[] Encode(IStunContext ctx)

Parameters

Type	Name	Description
IStunContext	ctx

Returns

Type	Description
Byte[]

GetAttribute<T>()

Declaration

protected T GetAttribute<T>()
    where T : Attribute

Returns

Type	Description
T

Type Parameters

Name	Description
T

ParseAsync(Stream, CancellationToken)

Parses StunMessage from stream.

Declaration

public static async Task<StunMessage> ParseAsync(Stream stream, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Stream	stream	A view of a sequence of STUN packet's bytes.
CancellationToken	cancellationToken	A cancellation token used to propagate notification that this operation should be canceled.

Returns

Type	Description
Task<StunMessage>	A StunMessage derived on bytes read from stream.