<FMLiveSwitchIWebSocket> Protocol Reference

Contract for an implementation of the WebSocket protocol v8. More...

Instance Methods

(void) - addOnLatestRoundTripTime:
 Adds a handler that is raised when the latest round trip time is calculated. More...
 
(int) - addOnLatestRoundTripTimeWithBlock
 Adds a handler that is raised when the latest round trip time is calculated. More...
 
(void) - addOnLatestRoundTripTimeWithBlock:
 Adds a handler that is raised when the latest round trip time is calculated. More...
 
(int) - bufferedAmount
 Gets the number of bytes buffered in the send queue. More...
 
(void) - close
 Closes the WebSocket connection. More...
 
(void) - closeWithCloseArgs:
 Closes the WebSocket connection. More...
 
(bool) - isOpen
 Gets a value indicating whether the WebSocket is connected. More...
 
(int) - lastRoundTripTime
 Gets the last round trip time. More...
 
(void) - openWithOpenArgs:
 Opens the WebSocket connection. More...
 
(void) - removeOnLatestRoundTripTime:
 Removes a handler that is raised when the latest round trip time is calculated. More...
 
(bool) - secure
 Gets a value indicating whether the WebSocket is secure. More...
 
(void) - sendWithSendArgs:
 Sends a message to the WebSocket server. More...
 

Detailed Description

Contract for an implementation of the WebSocket protocol v8.

Method Documentation

◆ addOnLatestRoundTripTime:

- (void) addOnLatestRoundTripTime: (FMLiveSwitchAction1 *)  value

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

◆ addOnLatestRoundTripTimeWithBlock

- (int) addOnLatestRoundTripTimeWithBlock

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

◆ addOnLatestRoundTripTimeWithBlock:

- (void) addOnLatestRoundTripTimeWithBlock: (void(^)(int))  valueBlock

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

◆ bufferedAmount

- (int) bufferedAmount

Gets the number of bytes buffered in the send queue.

Reimplemented in FMLiveSwitchWebSocket.

◆ close

- (void) close

Closes the WebSocket connection.

Reimplemented in FMLiveSwitchWebSocket.

◆ closeWithCloseArgs:

- (void) closeWithCloseArgs: (FMLiveSwitchWebSocketCloseArgs *)  closeArgs

Closes the WebSocket connection.

Parameters
closeArgsThe close arguments

Reimplemented in FMLiveSwitchWebSocket.

◆ isOpen

- (bool) isOpen

Gets a value indicating whether the WebSocket is connected.

Reimplemented in FMLiveSwitchWebSocket.

◆ lastRoundTripTime

- (int) lastRoundTripTime

Gets the last round trip time.

◆ openWithOpenArgs:

- (void) openWithOpenArgs: (FMLiveSwitchWebSocketOpenArgs *)  openArgs

Opens the WebSocket connection.

Parameters
openArgsThe open arguments.

Reimplemented in FMLiveSwitchWebSocket.

◆ removeOnLatestRoundTripTime:

- (void) removeOnLatestRoundTripTime: (FMLiveSwitchAction1 *)  value

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

◆ secure

- (bool) secure

Gets a value indicating whether the WebSocket is secure.

Reimplemented in FMLiveSwitchWebSocket.

◆ sendWithSendArgs:

- (void) sendWithSendArgs: (FMLiveSwitchWebSocketSendArgs *)  sendArgs

Sends a message to the WebSocket server.

Parameters
sendArgsThe send arguments.

Reimplemented in FMLiveSwitchWebSocket.