FMIceLinkWebSocketWebRequestTransfer Class Reference

Inherits from	FMIceLinkWebSocketTransfer : NSObject
Declared in	FMIceLinkWebSocketWebRequestTransfer.h FMIceLinkWebSocketWebRequestTransfer.m

Overview

Defines methods for transferring messages using the WebSocket protocol.

`– initWithUrl:`

Creates a new instance of FMIceLinkWebSocketWebRequestTransfer.

- (instancetype)initWithUrl:(NSString *)url

Parameters

`url`	The URL.

Discussion

Creates a new instance of FMIceLinkWebSocketWebRequestTransfer.

Declared In

FMIceLinkWebSocketWebRequestTransfer.h

`– openWithHeaders:`

Opens the WebSocket connection.

- (void)openWithHeaders:(FMIceLinkNameValueCollection *)headers

Discussion

Opens the WebSocket connection.

Declared In

FMIceLinkWebSocketWebRequestTransfer.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

FMIceLinkWebSocketWebRequestTransfer.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

FMIceLinkWebSocketWebRequestTransfer.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

FMIceLinkWebSocketWebRequestTransfer.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

FMIceLinkWebSocketWebRequestTransfer.h

`– shutdown`

Releases any resources and shuts down.

- (void)shutdown

Discussion

Releases any resources and shuts down.

Declared In

FMIceLinkWebSocketWebRequestTransfer.h

`+ webSocketWebRequestTransferWithUrl:`

Creates a new instance of FMIceLinkWebSocketWebRequestTransfer.

+ (FMIceLinkWebSocketWebRequestTransfer *)webSocketWebRequestTransferWithUrl:(NSString *)url

Parameters

`url`	The URL.

Discussion

Creates a new instance of FMIceLinkWebSocketWebRequestTransfer.

Declared In

FMIceLinkWebSocketWebRequestTransfer.h