Class WssPingMessage
Represents a WebSocket Ping message with a transaction identifier.
Inheritance
System.Object
WssPingMessage
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 WssPingMessageConstructors
WssPingMessage(String)
Initializes a new instance of the WssPingMessage class.
Declaration
public WssPingMessage(string transactionId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | transactionId | The transaction identifier for the ping message. |
Properties
TransactionId
Gets the transaction identifier associated with this ping message.
Declaration
public string TransactionId { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Methods
Parse(String)
Parses a string representation of a ping message into a WssPingMessage instance.
Declaration
public static WssPingMessage Parse(string message)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | message | The string to parse, which should be in the format "ls-ping {transactionId}". |
Returns
| Type | Description |
|---|---|
| WssPingMessage | A new instance of WssPingMessage containing the parsed transaction ID. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentException | Thrown when the message format is invalid. |
ToString()
Converts the ping message to its string representation.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| System.String | A string in the format "ls-ping {transactionId}". |
Overrides
System.Object.ToString()