 |
LiveSwitch iOS/macOS API Reference Documentation
|
|
LiveSwitch iOS/macOS API Reference Documentation
|
Open arguments for the FMLiveSwitchWebSocket class. More...
Instance Methods | |
| (int) | - handshakeTimeout |
| Gets the timeout for the handshake (in ms). More... | |
| (FMLiveSwitchManagedConcurrentDictionary< NSString *, NSString * > *) | - headers |
| Gets headers to send with the handshake request. More... | |
| (instancetype) | - init |
| Creates a new instance of. More... | |
| (int) | - keepAliveInterval |
| Gets the keep-alive interval for the stream (in ms). More... | |
| (int) | - keepAliveTimeout |
| Gets the keep-alive timeout for the stream (in ms). 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... | |
| (FMLiveSwitchRelayPort *) | - relayPort |
| Gets the relay port to dispatch messages. 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) | - setKeepAliveInterval: |
| Sets the keep-alive interval for the stream (in ms). More... | |
| (void) | - setKeepAliveTimeout: |
| Sets the keep-alive timeout for the stream (in ms). 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) | - setRelayPort: |
| Sets the relay port to dispatch messages. 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 all 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: |
| Removes a property value from 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... | |
Open arguments for the FMLiveSwitchWebSocket class.
| - (int) handshakeTimeout |
Gets the timeout for the handshake (in ms).
| - (FMLiveSwitchManagedConcurrentDictionary<NSString*,NSString*>*) headers |
Gets headers to send with the handshake request.
| - (instancetype) init |
Creates a new instance of.
Implements FMLiveSwitchDynamic.
| - (int) keepAliveInterval |
Gets the keep-alive interval for the stream (in ms).
Defaults to 5,000.
| - (int) keepAliveTimeout |
Gets the keep-alive timeout for the stream (in ms).
Defaults to 7,500.
| - (FMLiveSwitchAction1<FMLiveSwitchWebSocketOpenFailureArgs*>*) onFailure |
Gets the callback to invoke when a connection could not be established.
| - (FMLiveSwitchAction1<FMLiveSwitchWebSocketReceiveArgs*>*) onReceive |
Gets the callback to invoke when a message is received.
| - (FMLiveSwitchAction1<FMLiveSwitchHttpRequestCreatedArgs*>*) onRequestCreated |
Gets the callback to invoke before the handshake request is sent.
| - (FMLiveSwitchAction1<FMLiveSwitchHttpResponseReceivedArgs*>*) onResponseReceived |
Gets the callback to invoke after the handshake response is received.
| - (FMLiveSwitchAction1<FMLiveSwitchWebSocketStreamFailureArgs*>*) onStreamFailure |
Gets the callback to invoke when a successful connection breaks down.
| - (FMLiveSwitchAction1<FMLiveSwitchWebSocketOpenSuccessArgs*>*) onSuccess |
Gets the callback to invoke when a successful connection has been established.
| - (FMLiveSwitchRelayPort*) relayPort |
Gets the relay port to dispatch messages.
| - (id) sender |
Gets the sender of the request.
| - (void) setHandshakeTimeout: | (int) | value |
Sets the timeout for the handshake (in ms).
| - (void) setHeaders: | (FMLiveSwitchManagedConcurrentDictionary< NSString *, NSString * > *) | value |
Sets headers to send with the handshake request.
| - (void) setKeepAliveInterval: | (int) | value |
Sets the keep-alive interval for the stream (in ms).
Defaults to 5,000.
| - (void) setKeepAliveTimeout: | (int) | value |
Sets the keep-alive timeout for the stream (in ms).
Defaults to 7,500.
| - (void) setOnFailure: | (FMLiveSwitchAction1< FMLiveSwitchWebSocketOpenFailureArgs * > *) | value |
Sets the callback to invoke when a connection could not be established.
| - (FMLiveSwitchWebSocketOpenFailureArgs*) setOnFailureBlock |
Sets the callback to invoke when a connection could not be established.
| - (void) setOnFailureBlock: | (void(^)(FMLiveSwitchWebSocketOpenFailureArgs *)) | valueBlock |
Sets the callback to invoke when a connection could not be established.
| - (void) setOnReceive: | (FMLiveSwitchAction1< FMLiveSwitchWebSocketReceiveArgs * > *) | value |
Sets the callback to invoke when a message is received.
| - (FMLiveSwitchWebSocketReceiveArgs*) setOnReceiveBlock |
Sets the callback to invoke when a message is received.
| - (void) setOnReceiveBlock: | (void(^)(FMLiveSwitchWebSocketReceiveArgs *)) | valueBlock |
Sets the callback to invoke when a message is received.
| - (void) setOnRequestCreated: | (FMLiveSwitchAction1< FMLiveSwitchHttpRequestCreatedArgs * > *) | value |
Sets the callback to invoke before the handshake request is sent.
| - (FMLiveSwitchHttpRequestCreatedArgs*) setOnRequestCreatedBlock |
Sets the callback to invoke before the handshake request is sent.
| - (void) setOnRequestCreatedBlock: | (void(^)(FMLiveSwitchHttpRequestCreatedArgs *)) | valueBlock |
Sets the callback to invoke before the handshake request is sent.
| - (void) setOnResponseReceived: | (FMLiveSwitchAction1< FMLiveSwitchHttpResponseReceivedArgs * > *) | value |
Sets the callback to invoke after the handshake response is received.
| - (FMLiveSwitchHttpResponseReceivedArgs*) setOnResponseReceivedBlock |
Sets the callback to invoke after the handshake response is received.
| - (void) setOnResponseReceivedBlock: | (void(^)(FMLiveSwitchHttpResponseReceivedArgs *)) | valueBlock |
Sets the callback to invoke after the handshake response is received.
| - (void) setOnStreamFailure: | (FMLiveSwitchAction1< FMLiveSwitchWebSocketStreamFailureArgs * > *) | value |
Sets the callback to invoke when a successful connection breaks down.
| - (FMLiveSwitchWebSocketStreamFailureArgs*) setOnStreamFailureBlock |
Sets the callback to invoke when a successful connection breaks down.
| - (void) setOnStreamFailureBlock: | (void(^)(FMLiveSwitchWebSocketStreamFailureArgs *)) | valueBlock |
Sets the callback to invoke when a successful connection breaks down.
| - (void) setOnSuccess: | (FMLiveSwitchAction1< FMLiveSwitchWebSocketOpenSuccessArgs * > *) | value |
Sets the callback to invoke when a successful connection has been established.
| - (FMLiveSwitchWebSocketOpenSuccessArgs*) setOnSuccessBlock |
Sets the callback to invoke when a successful connection has been established.
| - (void) setOnSuccessBlock: | (void(^)(FMLiveSwitchWebSocketOpenSuccessArgs *)) | valueBlock |
Sets the callback to invoke when a successful connection has been established.
| - (void) setRelayPort: | (FMLiveSwitchRelayPort *) | value |
Sets the relay port to dispatch messages.
| - (void) setSender: | (id) | value |
Sets the sender of the request.
| - (void) setStreamTimeout: | (int) | value |
Sets the timeout for the stream (in ms).
| - (int) streamTimeout |
Gets the timeout for the stream (in ms).
| + (FMLiveSwitchWebSocketOpenArgs*) webSocketOpenArgs |
Creates a new instance of.