Class WssPongMessage

Represents a WebSocket Pong message with a transaction identifier.

Inheritance

System.Object

WssPongMessage

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: FM.LiveSwitch

Assembly: FM.LiveSwitch.dll

Syntax

public class WssPongMessage

Constructors

WssPongMessage(WssPingMessage)

Initializes a new instance of the WssPongMessage class with the same transaction ID as the ping message.

Declaration

public WssPongMessage(WssPingMessage ping)

Parameters

Type	Name	Description
WssPingMessage	ping	The ping message to respond to.

WssPongMessage(String)

Initializes a new instance of the WssPongMessage class.

Declaration

public WssPongMessage(string transactionId)

Parameters

Type	Name	Description
System.String	transactionId	The transaction identifier for the pong message.

Properties

TransactionId

Gets the transaction identifier associated with this pong message.

Declaration

public string TransactionId { get; }

Property Value

Type	Description
System.String

Methods

Parse(String)

Parses a string representation of a pong message into a WssPongMessage instance.

Declaration

public static WssPongMessage Parse(string message)

Parameters

Type	Name	Description
System.String	message	The string to parse, which should be in the format "ls-pong {transactionId}".

Returns

Type	Description
WssPongMessage	A new instance of WssPongMessage containing the parsed transaction ID.

Exceptions

Type	Condition
System.ArgumentException	Thrown when the message format is invalid.

ToString()

Converts the pong message to its string representation.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A string in the format "ls-pong {transactionId}".

Overrides

System.Object.ToString()