FMLiveSwitchWebSocketOpenArgs Class Reference

Open arguments for the FMLiveSwitchWebSocket class. More...

Instance Methods

(int) - handshakeTimeout
 Gets the timeout for the handshake (in ms). More...
 
(FMLiveSwitchNameValueCollection *) - headers
 Gets headers to send with the handshake request. More...
 
(instancetype) - init
 Creates a new instance of. More...
 
(FMLiveSwitchAction1< FMLiveSwitchWebSocketOpenFailureArgs * > *) - onFailure
 Gets the callback to invoke when a connection could not be established. More...
 
(FMLiveSwitchAction1< FMLiveSwitchWebSocketReceiveArgs * > *) - onReceive
 Gets the callback to invoke when a message is received. More...
 
(FMLiveSwitchAction1< FMLiveSwitchHttpRequestCreatedArgs * > *) - onRequestCreated
 Gets the callback to invoke before the handshake request is sent. More...
 
(FMLiveSwitchAction1< FMLiveSwitchHttpResponseReceivedArgs * > *) - onResponseReceived
 Gets the callback to invoke after the handshake response is received. More...
 
(FMLiveSwitchAction1< FMLiveSwitchWebSocketStreamFailureArgs * > *) - onStreamFailure
 Gets the callback to invoke when a successful connection breaks down. More...
 
(FMLiveSwitchAction1< FMLiveSwitchWebSocketOpenSuccessArgs * > *) - onSuccess
 Gets the callback to invoke when a successful connection has been established. More...
 
(id- sender
 Gets the sender of the request. More...
 
(void) - setHandshakeTimeout:
 Sets the timeout for the handshake (in ms). More...
 
(void) - setHeaders:
 Sets headers to send with the handshake request. More...
 
(void) - setOnFailure:
 Sets the callback to invoke when a connection could not be established. More...
 
(FMLiveSwitchWebSocketOpenFailureArgs *) - setOnFailureBlock
 Sets the callback to invoke when a connection could not be established. More...
 
(void) - setOnFailureBlock:
 Sets the callback to invoke when a connection could not be established. More...
 
(void) - setOnReceive:
 Sets the callback to invoke when a message is received. More...
 
(FMLiveSwitchWebSocketReceiveArgs *) - setOnReceiveBlock
 Sets the callback to invoke when a message is received. More...
 
(void) - setOnReceiveBlock:
 Sets the callback to invoke when a message is received. More...
 
(void) - setOnRequestCreated:
 Sets the callback to invoke before the handshake request is sent. More...
 
(FMLiveSwitchHttpRequestCreatedArgs *) - setOnRequestCreatedBlock
 Sets the callback to invoke before the handshake request is sent. More...
 
(void) - setOnRequestCreatedBlock:
 Sets the callback to invoke before the handshake request is sent. More...
 
(void) - setOnResponseReceived:
 Sets the callback to invoke after the handshake response is received. More...
 
(FMLiveSwitchHttpResponseReceivedArgs *) - setOnResponseReceivedBlock
 Sets the callback to invoke after the handshake response is received. More...
 
(void) - setOnResponseReceivedBlock:
 Sets the callback to invoke after the handshake response is received. More...
 
(void) - setOnStreamFailure:
 Sets the callback to invoke when a successful connection breaks down. More...
 
(FMLiveSwitchWebSocketStreamFailureArgs *) - setOnStreamFailureBlock
 Sets the callback to invoke when a successful connection breaks down. More...
 
(void) - setOnStreamFailureBlock:
 Sets the callback to invoke when a successful connection breaks down. More...
 
(void) - setOnSuccess:
 Sets the callback to invoke when a successful connection has been established. More...
 
(FMLiveSwitchWebSocketOpenSuccessArgs *) - setOnSuccessBlock
 Sets the callback to invoke when a successful connection has been established. More...
 
(void) - setOnSuccessBlock:
 Sets the callback to invoke when a successful connection has been established. More...
 
(void) - setSender:
 Sets the sender of the request. More...
 
(void) - setStreamTimeout:
 Sets the timeout for the stream (in ms). More...
 
(int) - streamTimeout
 Gets the timeout for the stream (in ms). More...
 
- Instance Methods inherited from FMLiveSwitchDynamic
(NSMutableDictionary< NSString *, id > *) - dynamicProperties
 Gets the dynamic properties on this instance. More...
 
(id- getDynamicValueWithKey:
 Gets a property value from the local cache. More...
 
(void) - setDynamicValueWithKey:value:
 Sets a property value in the local cache. More...
 
(bool) - unsetDynamicValueWithKey:
 Unsets a property value in the local cache. More...
 

Class Methods

(FMLiveSwitchWebSocketOpenArgs *) + webSocketOpenArgs
 Creates a new instance of. More...
 
- Class Methods inherited from FMLiveSwitchDynamic
(FMLiveSwitchDynamic *) + dynamic
 
- Class Methods inherited from FMLiveSwitchSerializable
(FMLiveSwitchSerializable *) + serializable
 Initializes a new instance of the FMLiveSwitchSerializable class. More...
 

Detailed Description

Open arguments for the FMLiveSwitchWebSocket class.

Method Documentation

◆ handshakeTimeout

- (int) handshakeTimeout

Gets the timeout for the handshake (in ms).

◆ headers

- (FMLiveSwitchNameValueCollection*) headers

Gets headers to send with the handshake request.

◆ init

- (instancetype) init

Creates a new instance of.

Implements FMLiveSwitchDynamic.

◆ onFailure

- (FMLiveSwitchAction1<FMLiveSwitchWebSocketOpenFailureArgs*>*) onFailure

Gets the callback to invoke when a connection could not be established.

◆ onReceive

- (FMLiveSwitchAction1<FMLiveSwitchWebSocketReceiveArgs*>*) onReceive

Gets the callback to invoke when a message is received.

◆ onRequestCreated

- (FMLiveSwitchAction1<FMLiveSwitchHttpRequestCreatedArgs*>*) onRequestCreated

Gets the callback to invoke before the handshake request is sent.

◆ onResponseReceived

- (FMLiveSwitchAction1<FMLiveSwitchHttpResponseReceivedArgs*>*) onResponseReceived

Gets the callback to invoke after the handshake response is received.

◆ onStreamFailure

- (FMLiveSwitchAction1<FMLiveSwitchWebSocketStreamFailureArgs*>*) onStreamFailure

Gets the callback to invoke when a successful connection breaks down.

◆ onSuccess

- (FMLiveSwitchAction1<FMLiveSwitchWebSocketOpenSuccessArgs*>*) onSuccess

Gets the callback to invoke when a successful connection has been established.

◆ sender

- (id) sender

Gets the sender of the request.

◆ setHandshakeTimeout:

- (void) setHandshakeTimeout: (int)  value

Sets the timeout for the handshake (in ms).

◆ setHeaders:

- (void) setHeaders: (FMLiveSwitchNameValueCollection *)  value

Sets headers to send with the handshake request.

◆ setOnFailure:

- (void) setOnFailure: (FMLiveSwitchAction1< FMLiveSwitchWebSocketOpenFailureArgs * > *)  value

Sets the callback to invoke when a connection could not be established.

◆ setOnFailureBlock

- (FMLiveSwitchWebSocketOpenFailureArgs*) setOnFailureBlock

Sets the callback to invoke when a connection could not be established.

◆ setOnFailureBlock:

- (void) setOnFailureBlock: (void(^)(FMLiveSwitchWebSocketOpenFailureArgs *))  valueBlock

Sets the callback to invoke when a connection could not be established.

◆ setOnReceive:

- (void) setOnReceive: (FMLiveSwitchAction1< FMLiveSwitchWebSocketReceiveArgs * > *)  value

Sets the callback to invoke when a message is received.

◆ setOnReceiveBlock

- (FMLiveSwitchWebSocketReceiveArgs*) setOnReceiveBlock

Sets the callback to invoke when a message is received.

◆ setOnReceiveBlock:

- (void) setOnReceiveBlock: (void(^)(FMLiveSwitchWebSocketReceiveArgs *))  valueBlock

Sets the callback to invoke when a message is received.

◆ setOnRequestCreated:

- (void) setOnRequestCreated: (FMLiveSwitchAction1< FMLiveSwitchHttpRequestCreatedArgs * > *)  value

Sets the callback to invoke before the handshake request is sent.

◆ setOnRequestCreatedBlock

- (FMLiveSwitchHttpRequestCreatedArgs*) setOnRequestCreatedBlock

Sets the callback to invoke before the handshake request is sent.

◆ setOnRequestCreatedBlock:

- (void) setOnRequestCreatedBlock: (void(^)(FMLiveSwitchHttpRequestCreatedArgs *))  valueBlock

Sets the callback to invoke before the handshake request is sent.

◆ setOnResponseReceived:

- (void) setOnResponseReceived: (FMLiveSwitchAction1< FMLiveSwitchHttpResponseReceivedArgs * > *)  value

Sets the callback to invoke after the handshake response is received.

◆ setOnResponseReceivedBlock

- (FMLiveSwitchHttpResponseReceivedArgs*) setOnResponseReceivedBlock

Sets the callback to invoke after the handshake response is received.

◆ setOnResponseReceivedBlock:

- (void) setOnResponseReceivedBlock: (void(^)(FMLiveSwitchHttpResponseReceivedArgs *))  valueBlock

Sets the callback to invoke after the handshake response is received.

◆ setOnStreamFailure:

- (void) setOnStreamFailure: (FMLiveSwitchAction1< FMLiveSwitchWebSocketStreamFailureArgs * > *)  value

Sets the callback to invoke when a successful connection breaks down.

◆ setOnStreamFailureBlock

- (FMLiveSwitchWebSocketStreamFailureArgs*) setOnStreamFailureBlock

Sets the callback to invoke when a successful connection breaks down.

◆ setOnStreamFailureBlock:

- (void) setOnStreamFailureBlock: (void(^)(FMLiveSwitchWebSocketStreamFailureArgs *))  valueBlock

Sets the callback to invoke when a successful connection breaks down.

◆ setOnSuccess:

- (void) setOnSuccess: (FMLiveSwitchAction1< FMLiveSwitchWebSocketOpenSuccessArgs * > *)  value

Sets the callback to invoke when a successful connection has been established.

◆ setOnSuccessBlock

- (FMLiveSwitchWebSocketOpenSuccessArgs*) setOnSuccessBlock

Sets the callback to invoke when a successful connection has been established.

◆ setOnSuccessBlock:

- (void) setOnSuccessBlock: (void(^)(FMLiveSwitchWebSocketOpenSuccessArgs *))  valueBlock

Sets the callback to invoke when a successful connection has been established.

◆ setSender:

- (void) setSender: (id value

Sets the sender of the request.

◆ setStreamTimeout:

- (void) setStreamTimeout: (int)  value

Sets the timeout for the stream (in ms).

◆ streamTimeout

- (int) streamTimeout

Gets the timeout for the stream (in ms).

◆ webSocketOpenArgs

+ (FMLiveSwitchWebSocketOpenArgs*) webSocketOpenArgs

Creates a new instance of.