 |
LiveSwitch iOS/macOS API Reference Documentation
|
|
LiveSwitch iOS/macOS API Reference Documentation
|
Base class that defines methods for transferring content over the WebSocket protocol. More...
Instance Methods | |
| (int) | - handshakeTimeout |
| Gets the timeout for the initial handshake (in ms). More... | |
| (instancetype) | - initWithUrl: |
| Initializes a new instance of the FMLiveSwitchWebSocketTransfer class. More... | |
| (FMLiveSwitchAction1< FMLiveSwitchWebSocketOpenFailureArgs * > *) | - onOpenFailure |
| Gets the callback to invoke if the handshake fails. More... | |
| (FMLiveSwitchAction1< FMLiveSwitchWebSocketOpenSuccessArgs * > *) | - onOpenSuccess |
| Gets the callback to invoke if the handshake succeeds. More... | |
| (FMLiveSwitchAction1< FMLiveSwitchHttpRequestCreatedArgs * > *) | - onRequestCreated |
| Gets the callback to invoke when the handshake request is created. More... | |
| (FMLiveSwitchAction1< FMLiveSwitchHttpResponseReceivedArgs * > *) | - onResponseReceived |
| Gets the callback to invoke when the handshake response is received. More... | |
| (FMLiveSwitchAction1< FMLiveSwitchWebSocketStreamFailureArgs * > *) | - onStreamFailure |
| Gets the callback to invoke if the stream errors out. More... | |
| (void) | - openWithHeaders: |
| Opens the socket. More... | |
| (void) | - sendAsyncWithRequestArgs:callback: |
| Sends a request asynchronously. More... | |
| (void) | - sendAsyncWithRequestArgs:callbackBlock: |
| Sends a request asynchronously. More... | |
| (FMLiveSwitchHttpResponseArgs *) | - sendAsyncWithRequestArgsAndCallbackBlock |
| Sends a request asynchronously. More... | |
| (id) | - sender |
| Gets the sender of the messages. More... | |
| (FMLiveSwitchHttpResponseArgs *) | - sendWithRequestArgs: |
| Sends a request synchronously. More... | |
| (void) | - setHandshakeTimeout: |
| Sets the timeout for the initial handshake (in ms). More... | |
| (void) | - setOnOpenFailure: |
| Sets the callback to invoke if the handshake fails. More... | |
| (FMLiveSwitchWebSocketOpenFailureArgs *) | - setOnOpenFailureBlock |
| Sets the callback to invoke if the handshake fails. More... | |
| (void) | - setOnOpenFailureBlock: |
| Sets the callback to invoke if the handshake fails. More... | |
| (void) | - setOnOpenSuccess: |
| Sets the callback to invoke if the handshake succeeds. More... | |
| (FMLiveSwitchWebSocketOpenSuccessArgs *) | - setOnOpenSuccessBlock |
| Sets the callback to invoke if the handshake succeeds. More... | |
| (void) | - setOnOpenSuccessBlock: |
| Sets the callback to invoke if the handshake succeeds. More... | |
| (void) | - setOnRequestCreated: |
| Sets the callback to invoke when the handshake request is created. More... | |
| (FMLiveSwitchHttpRequestCreatedArgs *) | - setOnRequestCreatedBlock |
| Sets the callback to invoke when the handshake request is created. More... | |
| (void) | - setOnRequestCreatedBlock: |
| Sets the callback to invoke when the handshake request is created. More... | |
| (void) | - setOnResponseReceived: |
| Sets the callback to invoke when the handshake response is received. More... | |
| (FMLiveSwitchHttpResponseReceivedArgs *) | - setOnResponseReceivedBlock |
| Sets the callback to invoke when the handshake response is received. More... | |
| (void) | - setOnResponseReceivedBlock: |
| Sets the callback to invoke when the handshake response is received. More... | |
| (void) | - setOnStreamFailure: |
| Sets the callback to invoke if the stream errors out. More... | |
| (FMLiveSwitchWebSocketStreamFailureArgs *) | - setOnStreamFailureBlock |
| Sets the callback to invoke if the stream errors out. More... | |
| (void) | - setOnStreamFailureBlock: |
| Sets the callback to invoke if the stream errors out. More... | |
| (void) | - setSender: |
| Sets the sender of the messages. More... | |
| (void) | - setStreamTimeout: |
| Sets the timeout for the stream (in ms). More... | |
| (void) | - setUrl: |
| Sets the URL. More... | |
| (void) | - shutdown |
| Releases any resources and shuts down. More... | |
| (int) | - streamTimeout |
| Gets the timeout for the stream (in ms). More... | |
| (NSString *) | - url |
| Gets the URL. More... | |
Class Methods | |
| (FMLiveSwitchWebSocketTransfer *) | + webSocketTransferWithUrl: |
| Initializes a new instance of the FMLiveSwitchWebSocketTransfer class. More... | |
Base class that defines methods for transferring content over the WebSocket protocol.
| - (int) handshakeTimeout |
Gets the timeout for the initial handshake (in ms).
| - (instancetype) initWithUrl: | (NSString *) | url |
Initializes a new instance of the FMLiveSwitchWebSocketTransfer class.
| url | The URL. |
Implemented in FMLiveSwitchWebSocketWebRequestTransfer.
| - (FMLiveSwitchAction1<FMLiveSwitchWebSocketOpenFailureArgs*>*) onOpenFailure |
Gets the callback to invoke if the handshake fails.
| - (FMLiveSwitchAction1<FMLiveSwitchWebSocketOpenSuccessArgs*>*) onOpenSuccess |
Gets the callback to invoke if the handshake succeeds.
| - (FMLiveSwitchAction1<FMLiveSwitchHttpRequestCreatedArgs*>*) onRequestCreated |
Gets the callback to invoke when the handshake request is created.
| - (FMLiveSwitchAction1<FMLiveSwitchHttpResponseReceivedArgs*>*) onResponseReceived |
Gets the callback to invoke when the handshake response is received.
| - (FMLiveSwitchAction1<FMLiveSwitchWebSocketStreamFailureArgs*>*) onStreamFailure |
Gets the callback to invoke if the stream errors out.
| - (void) openWithHeaders: | (FMLiveSwitchNameValueCollection *) | headers |
Opens the socket.
| headers | The headers to pass in with the initial handshake. |
Implemented in FMLiveSwitchWebSocketWebRequestTransfer.
| - (void) sendAsyncWithRequestArgs: | (FMLiveSwitchHttpRequestArgs *) | requestArgs | |
| callback: | (FMLiveSwitchAction1< FMLiveSwitchHttpResponseArgs * > *) | callback | |
Sends a request asynchronously.
| requestArgs | The request parameters. |
| callback | The callback to execute with the resulting response. |
Implemented in FMLiveSwitchWebSocketWebRequestTransfer.
| - (void) sendAsyncWithRequestArgs: | (FMLiveSwitchHttpRequestArgs *) | requestArgs | |
| callbackBlock: | (void(^)(FMLiveSwitchHttpResponseArgs *)) | callbackBlock | |
Sends a request asynchronously.
| requestArgs | The request parameters. |
| callbackBlock | The callback to execute with the resulting response. |
Implemented in FMLiveSwitchWebSocketWebRequestTransfer.
| - (FMLiveSwitchHttpResponseArgs*) sendAsyncWithRequestArgsAndCallbackBlock |
Sends a request asynchronously.
@inlineparam requestArgs The request parameters. @inlineparam callbackBlock The callback to execute with the resulting response.
Implemented in FMLiveSwitchWebSocketWebRequestTransfer.
| - (id) sender |
Gets the sender of the messages.
| - (FMLiveSwitchHttpResponseArgs*) sendWithRequestArgs: | (FMLiveSwitchHttpRequestArgs *) | requestArgs |
Sends a request synchronously.
| requestArgs | The request parameters. |
Implemented in FMLiveSwitchWebSocketWebRequestTransfer.
| - (void) setHandshakeTimeout: | (int) | value |
Sets the timeout for the initial handshake (in ms).
| - (void) setOnOpenFailure: | (FMLiveSwitchAction1< FMLiveSwitchWebSocketOpenFailureArgs * > *) | value |
Sets the callback to invoke if the handshake fails.
| - (FMLiveSwitchWebSocketOpenFailureArgs*) setOnOpenFailureBlock |
Sets the callback to invoke if the handshake fails.
| - (void) setOnOpenFailureBlock: | (void(^)(FMLiveSwitchWebSocketOpenFailureArgs *)) | valueBlock |
Sets the callback to invoke if the handshake fails.
| - (void) setOnOpenSuccess: | (FMLiveSwitchAction1< FMLiveSwitchWebSocketOpenSuccessArgs * > *) | value |
Sets the callback to invoke if the handshake succeeds.
| - (FMLiveSwitchWebSocketOpenSuccessArgs*) setOnOpenSuccessBlock |
Sets the callback to invoke if the handshake succeeds.
| - (void) setOnOpenSuccessBlock: | (void(^)(FMLiveSwitchWebSocketOpenSuccessArgs *)) | valueBlock |
Sets the callback to invoke if the handshake succeeds.
| - (void) setOnRequestCreated: | (FMLiveSwitchAction1< FMLiveSwitchHttpRequestCreatedArgs * > *) | value |
Sets the callback to invoke when the handshake request is created.
| - (FMLiveSwitchHttpRequestCreatedArgs*) setOnRequestCreatedBlock |
Sets the callback to invoke when the handshake request is created.
| - (void) setOnRequestCreatedBlock: | (void(^)(FMLiveSwitchHttpRequestCreatedArgs *)) | valueBlock |
Sets the callback to invoke when the handshake request is created.
| - (void) setOnResponseReceived: | (FMLiveSwitchAction1< FMLiveSwitchHttpResponseReceivedArgs * > *) | value |
Sets the callback to invoke when the handshake response is received.
| - (FMLiveSwitchHttpResponseReceivedArgs*) setOnResponseReceivedBlock |
Sets the callback to invoke when the handshake response is received.
| - (void) setOnResponseReceivedBlock: | (void(^)(FMLiveSwitchHttpResponseReceivedArgs *)) | valueBlock |
Sets the callback to invoke when the handshake response is received.
| - (void) setOnStreamFailure: | (FMLiveSwitchAction1< FMLiveSwitchWebSocketStreamFailureArgs * > *) | value |
Sets the callback to invoke if the stream errors out.
| - (FMLiveSwitchWebSocketStreamFailureArgs*) setOnStreamFailureBlock |
Sets the callback to invoke if the stream errors out.
| - (void) setOnStreamFailureBlock: | (void(^)(FMLiveSwitchWebSocketStreamFailureArgs *)) | valueBlock |
Sets the callback to invoke if the stream errors out.
| - (void) setSender: | (id) | value |
Sets the sender of the messages.
| - (void) setStreamTimeout: | (int) | value |
Sets the timeout for the stream (in ms).
| - (void) setUrl: | (NSString *) | value |
Sets the URL.
| - (void) shutdown |
Releases any resources and shuts down.
Implemented in FMLiveSwitchWebSocketWebRequestTransfer.
| - (int) streamTimeout |
Gets the timeout for the stream (in ms).
| - (NSString*) url |
Gets the URL.
| + (FMLiveSwitchWebSocketTransfer*) webSocketTransferWithUrl: | (NSString *) | url |
Initializes a new instance of the FMLiveSwitchWebSocketTransfer class.
| url | The URL. |