FMLiveSwitchWebSocketBase Class Reference

WebSocket base properties/methods. More...

Instance Methods

(instancetype) - init
 
(void) - raiseCloseCompleteWithCloseArgs:statusCode:reason:
 Raises the close complete callback. 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...
 

Class Methods

(FMLiveSwitchWebSocketBase *) + webSocketBase
 

Detailed Description

WebSocket base properties/methods.

Method Documentation

◆ init

- (instancetype) init

◆ raiseCloseCompleteWithCloseArgs:statusCode:reason:

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

Raises the close complete callback.

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

◆ raiseOpenFailureWithOpenArgs:statusCode:exception:

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

Raises the open failure callback.

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

◆ raiseOpenSuccessWithOpenArgs:

- (void) raiseOpenSuccessWithOpenArgs: (FMLiveSwitchWebSocketOpenArgs *)  openArgs

Raises the open success callback.

Parameters
openArgsThe open arguments.

◆ raiseReceiveWithOpenArgs:textMessage:binaryMessage:

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

Raises the receive callback.

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

◆ raiseStreamFailureWithOpenArgs:statusCode:exception:

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

Raises the stream failure callback.

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

◆ webSocketBase

+ (FMLiveSwitchWebSocketBase*) webSocketBase