FMIceLinkWebSocketTransfer Class Reference

Inherits from NSObject
Declared in FMIceLinkWebSocketTransfer.h
FMIceLinkWebSocketTransfer.m

Overview

Base class that defines methods for transferring content over the WebSocket protocol.

– handshakeTimeout

Gets the timeout for the initial handshake (in ms).
- (int)handshakeTimeout

Discussion

Gets the timeout for the initial handshake (in ms).

Declared In

FMIceLinkWebSocketTransfer.h

– initWithUrl:

Initializes a new instance of the FMIceLinkWebSocketTransfer class.
- (instancetype)initWithUrl:(NSString *)url

Parameters

url

The URL.

Discussion

Initializes a new instance of the FMIceLinkWebSocketTransfer class.

Declared In

FMIceLinkWebSocketTransfer.h

– onOpenFailure

Gets the callback to invoke if the handshake fails.
- (FMIceLinkAction1<FMIceLinkWebSocketOpenFailureArgs*> *)onOpenFailure

Discussion

Gets the callback to invoke if the handshake fails.

Declared In

FMIceLinkWebSocketTransfer.h

– onOpenSuccess

Gets the callback to invoke if the handshake succeeds.
- (FMIceLinkAction1<FMIceLinkWebSocketOpenSuccessArgs*> *)onOpenSuccess

Discussion

Gets the callback to invoke if the handshake succeeds.

Declared In

FMIceLinkWebSocketTransfer.h

– onRequestCreated

Gets the callback to invoke when the handshake request is created.
- (FMIceLinkAction1<FMIceLinkHttpRequestCreatedArgs*> *)onRequestCreated

Discussion

Gets the callback to invoke when the handshake request is created.

Declared In

FMIceLinkWebSocketTransfer.h

– onResponseReceived

Gets the callback to invoke when the handshake response is received.
- (FMIceLinkAction1<FMIceLinkHttpResponseReceivedArgs*> *)onResponseReceived

Discussion

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

Declared In

FMIceLinkWebSocketTransfer.h

– onStreamFailure

Gets the callback to invoke if the stream errors out.
- (FMIceLinkAction1<FMIceLinkWebSocketStreamFailureArgs*> *)onStreamFailure

Discussion

Gets the callback to invoke if the stream errors out.

Declared In

FMIceLinkWebSocketTransfer.h

– openWithHeaders:

Opens the socket.
- (void)openWithHeaders:(FMIceLinkNameValueCollection *)headers

Parameters

headers

The headers to pass in with the initial handshake.

Discussion

Opens the socket.

Declared In

FMIceLinkWebSocketTransfer.h

– sendAsyncWithRequestArgs:callback:

Sends a request asynchronously.
- (void)sendAsyncWithRequestArgs:(FMIceLinkHttpRequestArgs *)requestArgs callback:(FMIceLinkAction1<FMIceLinkHttpResponseArgs*> *)callback

Parameters

requestArgs

The request parameters.
callback

The callback to execute with the resulting response.

Discussion

Sends a request asynchronously.

Declared In

FMIceLinkWebSocketTransfer.h

– sendAsyncWithRequestArgs:callbackBlock:

Sends a request asynchronously.
- (void)sendAsyncWithRequestArgs:(FMIceLinkHttpRequestArgs *)requestArgs callbackBlock:(void ( ^ ) ( FMIceLinkHttpResponseArgs *))callbackBlock

Parameters

requestArgs

The request parameters.
callbackBlock

The callback to execute with the resulting response.

Discussion

Sends a request asynchronously.

Declared In

FMIceLinkWebSocketTransfer.h

– sendAsyncWithRequestArgsAndCallbackBlock

Sends a request asynchronously.

@inlineparam requestArgs The request parameters. @inlineparam callbackBlock The callback to execute with the resulting response.

- (void ( ^ ) ( FMIceLinkHttpRequestArgs *, void ( ^ ) ( FMIceLinkHttpResponseArgs *) ))sendAsyncWithRequestArgsAndCallbackBlock

Discussion

Sends a request asynchronously.

@inlineparam requestArgs The request parameters. @inlineparam callbackBlock The callback to execute with the resulting response.

Declared In

FMIceLinkWebSocketTransfer.h

– sender

Gets the sender of the messages.
- (id)sender

Discussion

Gets the sender of the messages.

Declared In

FMIceLinkWebSocketTransfer.h

– sendWithRequestArgs:

Sends a request synchronously.
- (FMIceLinkHttpResponseArgs *)sendWithRequestArgs:(FMIceLinkHttpRequestArgs *)requestArgs

Parameters

requestArgs

The request parameters.

Return Value

The response parameters.

Discussion

Sends a request synchronously.

Declared In

FMIceLinkWebSocketTransfer.h

– setHandshakeTimeout:

Sets the timeout for the initial handshake (in ms).
- (void)setHandshakeTimeout:(int)value

Discussion

Sets the timeout for the initial handshake (in ms).

Declared In

FMIceLinkWebSocketTransfer.h

– setOnOpenFailure:

Sets the callback to invoke if the handshake fails.
- (void)setOnOpenFailure:(FMIceLinkAction1<FMIceLinkWebSocketOpenFailureArgs*> *)value

Discussion

Sets the callback to invoke if the handshake fails.

Declared In

FMIceLinkWebSocketTransfer.h

– setOnOpenFailureBlock

Sets the callback to invoke if the handshake fails.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkWebSocketOpenFailureArgs *) ))setOnOpenFailureBlock

Discussion

Sets the callback to invoke if the handshake fails.

Declared In

FMIceLinkWebSocketTransfer.h

– setOnOpenFailureBlock:

Sets the callback to invoke if the handshake fails.
- (void)setOnOpenFailureBlock:(void ( ^ ) ( FMIceLinkWebSocketOpenFailureArgs *))valueBlock

Discussion

Sets the callback to invoke if the handshake fails.

Declared In

FMIceLinkWebSocketTransfer.h

– setOnOpenSuccess:

Sets the callback to invoke if the handshake succeeds.
- (void)setOnOpenSuccess:(FMIceLinkAction1<FMIceLinkWebSocketOpenSuccessArgs*> *)value

Discussion

Sets the callback to invoke if the handshake succeeds.

Declared In

FMIceLinkWebSocketTransfer.h

– setOnOpenSuccessBlock

Sets the callback to invoke if the handshake succeeds.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkWebSocketOpenSuccessArgs *) ))setOnOpenSuccessBlock

Discussion

Sets the callback to invoke if the handshake succeeds.

Declared In

FMIceLinkWebSocketTransfer.h

– setOnOpenSuccessBlock:

Sets the callback to invoke if the handshake succeeds.
- (void)setOnOpenSuccessBlock:(void ( ^ ) ( FMIceLinkWebSocketOpenSuccessArgs *))valueBlock

Discussion

Sets the callback to invoke if the handshake succeeds.

Declared In

FMIceLinkWebSocketTransfer.h

– setOnRequestCreated:

Sets the callback to invoke when the handshake request is created.
- (void)setOnRequestCreated:(FMIceLinkAction1<FMIceLinkHttpRequestCreatedArgs*> *)value

Discussion

Sets the callback to invoke when the handshake request is created.

Declared In

FMIceLinkWebSocketTransfer.h

– setOnRequestCreatedBlock

Sets the callback to invoke when the handshake request is created.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkHttpRequestCreatedArgs *) ))setOnRequestCreatedBlock

Discussion

Sets the callback to invoke when the handshake request is created.

Declared In

FMIceLinkWebSocketTransfer.h

– setOnRequestCreatedBlock:

Sets the callback to invoke when the handshake request is created.
- (void)setOnRequestCreatedBlock:(void ( ^ ) ( FMIceLinkHttpRequestCreatedArgs *))valueBlock

Discussion

Sets the callback to invoke when the handshake request is created.

Declared In

FMIceLinkWebSocketTransfer.h

– setOnResponseReceived:

Sets the callback to invoke when the handshake response is received.
- (void)setOnResponseReceived:(FMIceLinkAction1<FMIceLinkHttpResponseReceivedArgs*> *)value

Discussion

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

Declared In

FMIceLinkWebSocketTransfer.h

– setOnResponseReceivedBlock

Sets the callback to invoke when the handshake response is received.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkHttpResponseReceivedArgs *) ))setOnResponseReceivedBlock

Discussion

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

Declared In

FMIceLinkWebSocketTransfer.h

– setOnResponseReceivedBlock:

Sets the callback to invoke when the handshake response is received.
- (void)setOnResponseReceivedBlock:(void ( ^ ) ( FMIceLinkHttpResponseReceivedArgs *))valueBlock

Discussion

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

Declared In

FMIceLinkWebSocketTransfer.h

– setOnStreamFailure:

Sets the callback to invoke if the stream errors out.
- (void)setOnStreamFailure:(FMIceLinkAction1<FMIceLinkWebSocketStreamFailureArgs*> *)value

Discussion

Sets the callback to invoke if the stream errors out.

Declared In

FMIceLinkWebSocketTransfer.h

– setOnStreamFailureBlock

Sets the callback to invoke if the stream errors out.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkWebSocketStreamFailureArgs *) ))setOnStreamFailureBlock

Discussion

Sets the callback to invoke if the stream errors out.

Declared In

FMIceLinkWebSocketTransfer.h

– setOnStreamFailureBlock:

Sets the callback to invoke if the stream errors out.
- (void)setOnStreamFailureBlock:(void ( ^ ) ( FMIceLinkWebSocketStreamFailureArgs *))valueBlock

Discussion

Sets the callback to invoke if the stream errors out.

Declared In

FMIceLinkWebSocketTransfer.h

– setSender:

Sets the [sender](#//api/name/sender) of the messages.
- (void)setSender:(id)value

Discussion

Sets the [sender](#//api/name/sender) of the messages.

Declared In

FMIceLinkWebSocketTransfer.h

– setStreamTimeout:

Sets the timeout for the stream (in ms).
- (void)setStreamTimeout:(int)value

Discussion

Sets the timeout for the stream (in ms).

Declared In

FMIceLinkWebSocketTransfer.h

– setUrl:

Sets the URL.
- (void)setUrl:(NSString *)value

Discussion

Sets the URL.

Declared In

FMIceLinkWebSocketTransfer.h

– shutdown

Releases any resources and shuts down.
- (void)shutdown

Discussion

Releases any resources and shuts down.

Declared In

FMIceLinkWebSocketTransfer.h

– streamTimeout

Gets the timeout for the stream (in ms).
- (int)streamTimeout

Discussion

Gets the timeout for the stream (in ms).

Declared In

FMIceLinkWebSocketTransfer.h

– url

Gets the URL.
- (NSString *)url

Discussion

Gets the URL.

Declared In

FMIceLinkWebSocketTransfer.h

+ webSocketTransferWithUrl:

Initializes a new instance of the FMIceLinkWebSocketTransfer class.
+ (FMIceLinkWebSocketTransfer *)webSocketTransferWithUrl:(NSString *)url

Parameters

url

The URL.

Discussion

Initializes a new instance of the FMIceLinkWebSocketTransfer class.

Declared In

FMIceLinkWebSocketTransfer.h