fm.liveswitch.WssPingMessage Class Reference

Represents a WebSocket Ping message with a transaction identifier. More...

Public Member Functions

String getTransactionId ()
 Gets the transaction identifier associated with this ping message. More...
 
String toString ()
 Converts the ping message to its string representation. More...
 
 WssPingMessage (String transactionId)
 Initializes a new instance of the fm.liveswitch.WssPingMessage class. More...
 

Static Public Member Functions

static fm.liveswitch.WssPingMessage parse (String message)
 Parses a string representation of a ping message into a fm.liveswitch.WssPingMessage instance. More...
 

Detailed Description

Represents a WebSocket Ping message with a transaction identifier.

Constructor & Destructor Documentation

◆ WssPingMessage()

fm.liveswitch.WssPingMessage.WssPingMessage ( String  transactionId)

Initializes a new instance of the fm.liveswitch.WssPingMessage class.

Parameters
transactionIdThe transaction identifier for the ping message.

Member Function Documentation

◆ getTransactionId()

String fm.liveswitch.WssPingMessage.getTransactionId ( )

Gets the transaction identifier associated with this ping message.

◆ parse()

static fm.liveswitch.WssPingMessage fm.liveswitch.WssPingMessage.parse ( String  message)
static

Parses a string representation of a ping message into a fm.liveswitch.WssPingMessage instance.

Parameters
messageThe string to parse, which should be in the format "ls-ping {transactionId}".
Returns
A new instance of fm.liveswitch.WssPingMessage containing the parsed transaction ID.

◆ toString()

String fm.liveswitch.WssPingMessage.toString ( )

Converts the ping message to its string representation.

Returns
A string in the format "ls-ping {transactionId}".