FMLiveSwitchWebSocketBase Class Reference

WebSocket base properties/methods. 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...
(instancetype)	- init
(int)	- lastRoundTripTime
	Gets the last round trip time. More...
(void)	- raiseCloseCompleteWithCloseArgs:statusCode:reason:
	Raises the close complete callback. More...
(void)	- raiseOnLatestRoundTripTime:
	Raises the OnLatestRoundTripTime event. More...
(void)	- raiseOpenFailureWithOpenArgs:statusCode:exception:
	Raises the open failure callback. More...
(void)	- raiseOpenSuccessWithOpenArgs:
	Raises the open success callback. More...
(void)	- raiseReceiveWithOpenArgs:textMessage:binaryMessage:
	Raises the receive callback. More...
(void)	- raiseStreamFailureWithOpenArgs:statusCode:exception:
	Raises the stream failure callback. More...
(void)	- removeOnLatestRoundTripTime:
	Removes a handler that is raised when the latest round trip time is calculated. More...
(void)	- setLastRoundTripTime:
	Sets the last round trip time. More...

Class Methods
(FMLiveSwitchWebSocketBase *)	+ webSocketBase

Detailed Description

WebSocket base properties/methods.

Method Documentation

addOnLatestRoundTripTime:

- (void) addOnLatestRoundTripTime:

(FMLiveSwitchAction1< id > *)

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.

init

- (instancetype) init

lastRoundTripTime

- (int) lastRoundTripTime

Gets the last round trip time.

raiseCloseCompleteWithCloseArgs:statusCode:reason:

- (void) raiseCloseCompleteWithCloseArgs:		(FMLiveSwitchWebSocketCloseArgs *)	closeArgs
statusCode:		(FMLiveSwitchWebSocketStatusCode)	statusCode
reason:		(NSString *)	reason

Raises the close complete callback.

Parameters

closeArgs	The close arguments.
statusCode	The status code.
reason	The reason.

raiseOnLatestRoundTripTime:

- (void) raiseOnLatestRoundTripTime:

(int)

value

Raises the OnLatestRoundTripTime event.

Parameters

value

raiseOpenFailureWithOpenArgs:statusCode:exception:

- (void) raiseOpenFailureWithOpenArgs:		(FMLiveSwitchWebSocketOpenArgs *)	openArgs
statusCode:		(FMLiveSwitchWebSocketStatusCode)	statusCode
exception:		(NSException *)	exception

Raises the open failure callback.

Parameters

openArgs	The open arguments.
statusCode	The status code.
exception	The exception.

raiseOpenSuccessWithOpenArgs:

- (void) raiseOpenSuccessWithOpenArgs:

(FMLiveSwitchWebSocketOpenArgs *)

openArgs

Raises the open success callback.

Parameters

openArgs

The open arguments.

raiseReceiveWithOpenArgs:textMessage:binaryMessage:

- (void) raiseReceiveWithOpenArgs:		(FMLiveSwitchWebSocketOpenArgs *)	openArgs
textMessage:		(NSString *)	textMessage
binaryMessage:		(NSMutableData *)	binaryMessage

Raises the receive callback.

Parameters

openArgs	The open arguments.
textMessage	The text message.
binaryMessage	The binary message.

raiseStreamFailureWithOpenArgs:statusCode:exception:

- (void) raiseStreamFailureWithOpenArgs:		(FMLiveSwitchWebSocketOpenArgs *)	openArgs
statusCode:		(FMLiveSwitchWebSocketStatusCode)	statusCode
exception:		(NSException *)	exception

Raises the stream failure callback.

Parameters

openArgs	The open arguments.
statusCode	The status code.
exception	The exception.

removeOnLatestRoundTripTime:

- (void) removeOnLatestRoundTripTime:

(FMLiveSwitchAction1< id > *)

value

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

setLastRoundTripTime:

- (void) setLastRoundTripTime:

(int)

value

Sets the last round trip time.

webSocketBase

+ (FMLiveSwitchWebSocketBase*) webSocketBase