fm.liveswitch.WssPongMessage Class Reference

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

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

Represents a WebSocket Pong message with a transaction identifier.

Constructor & Destructor Documentation

◆ WssPongMessage() [1/2]

fm.liveswitch.WssPongMessage.WssPongMessage ( fm.liveswitch.WssPingMessage  ping)

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

Parameters
pingThe ping message to respond to.

◆ WssPongMessage() [2/2]

fm.liveswitch.WssPongMessage.WssPongMessage ( String  transactionId)

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

Parameters
transactionIdThe transaction identifier for the pong message.

Member Function Documentation

◆ getTransactionId()

String fm.liveswitch.WssPongMessage.getTransactionId ( )

Gets the transaction identifier associated with this pong message.

◆ parse()

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

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

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

◆ toString()

String fm.liveswitch.WssPongMessage.toString ( )

Converts the pong message to its string representation.

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