fm.liveswitch.WebSocketBase Class Reference

WebSocket base properties/methods. More...

Public Member Functions

void addOnLatestRoundTripTime (fm.liveswitch.IAction1< Integer > value)
 Adds a handler that is raised when the latest round trip time is calculated. More...
 
int getLastRoundTripTime ()
 Gets the last round trip time. More...
 
void removeOnLatestRoundTripTime (fm.liveswitch.IAction1< Integer > value)
 Removes a handler that is raised when the latest round trip time is calculated. More...
 
 WebSocketBase ()
 

Protected Member Functions

void raiseCloseComplete (fm.liveswitch.WebSocketCloseArgs closeArgs, fm.liveswitch.WebSocketStatusCode statusCode, String reason)
 Raises the close complete callback. More...
 
void raiseOnLatestRoundTripTime (int value)
 Raises the OnLatestRoundTripTime event. More...
 
void raiseOpenFailure (fm.liveswitch.WebSocketOpenArgs openArgs, fm.liveswitch.WebSocketStatusCode statusCode, java.lang.Exception exception)
 Raises the open failure callback. More...
 
void raiseOpenSuccess (fm.liveswitch.WebSocketOpenArgs openArgs)
 Raises the open success callback. More...
 
void raiseReceive (fm.liveswitch.WebSocketOpenArgs openArgs, String textMessage, byte[] binaryMessage)
 Raises the receive callback. More...
 
void raiseStreamFailure (fm.liveswitch.WebSocketOpenArgs openArgs, fm.liveswitch.WebSocketStatusCode statusCode, java.lang.Exception exception)
 Raises the stream failure callback. More...
 
void setLastRoundTripTime (int value)
 Sets the last round trip time. More...
 

Detailed Description

WebSocket base properties/methods.

Constructor & Destructor Documentation

◆ WebSocketBase()

fm.liveswitch.WebSocketBase.WebSocketBase ( )

Member Function Documentation

◆ addOnLatestRoundTripTime()

void fm.liveswitch.WebSocketBase.addOnLatestRoundTripTime ( fm.liveswitch.IAction1< Integer >  value)

Adds a handler that is raised when the latest round trip time is calculated.

◆ getLastRoundTripTime()

int fm.liveswitch.WebSocketBase.getLastRoundTripTime ( )

Gets the last round trip time.

◆ raiseCloseComplete()

void fm.liveswitch.WebSocketBase.raiseCloseComplete ( fm.liveswitch.WebSocketCloseArgs  closeArgs,
fm.liveswitch.WebSocketStatusCode  statusCode,
String  reason 
)
protected

Raises the close complete callback.

Parameters
closeArgsThe close arguments.
statusCodeThe status code.
reasonThe reason.

◆ raiseOnLatestRoundTripTime()

void fm.liveswitch.WebSocketBase.raiseOnLatestRoundTripTime ( int  value)
protected

Raises the OnLatestRoundTripTime event.

Parameters
value

◆ raiseOpenFailure()

void fm.liveswitch.WebSocketBase.raiseOpenFailure ( fm.liveswitch.WebSocketOpenArgs  openArgs,
fm.liveswitch.WebSocketStatusCode  statusCode,
java.lang.Exception  exception 
)
protected

Raises the open failure callback.

Parameters
openArgsThe open arguments.
statusCodeThe status code.
exceptionThe exception.

◆ raiseOpenSuccess()

void fm.liveswitch.WebSocketBase.raiseOpenSuccess ( fm.liveswitch.WebSocketOpenArgs  openArgs)
protected

Raises the open success callback.

Parameters
openArgsThe open arguments.

◆ raiseReceive()

void fm.liveswitch.WebSocketBase.raiseReceive ( fm.liveswitch.WebSocketOpenArgs  openArgs,
String  textMessage,
byte[]  binaryMessage 
)
protected

Raises the receive callback.

Parameters
openArgsThe open arguments.
textMessageThe text message.
binaryMessageThe binary message.

◆ raiseStreamFailure()

void fm.liveswitch.WebSocketBase.raiseStreamFailure ( fm.liveswitch.WebSocketOpenArgs  openArgs,
fm.liveswitch.WebSocketStatusCode  statusCode,
java.lang.Exception  exception 
)
protected

Raises the stream failure callback.

Parameters
openArgsThe open arguments.
statusCodeThe status code.
exceptionThe exception.

◆ removeOnLatestRoundTripTime()

void fm.liveswitch.WebSocketBase.removeOnLatestRoundTripTime ( fm.liveswitch.IAction1< Integer >  value)

Removes a handler that is raised when the latest round trip time is calculated.

◆ setLastRoundTripTime()

void fm.liveswitch.WebSocketBase.setLastRoundTripTime ( int  value)
protected

Sets the last round trip time.