FMIceLinkWebSocketOpenArgs Class Reference

Inherits from FMIceLinkDynamic : FMIceLinkSerializable : NSObject
Declared in FMIceLinkWebSocketOpenArgs.h
FMIceLinkWebSocketOpenArgs.m

Overview

Open arguments for the [FMIceLinkWebSocket](../Classes/FMIceLinkWebSocket.html) class.

– handshakeTimeout

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

Discussion

Gets the timeout for the handshake (in ms).

Declared In

FMIceLinkWebSocketOpenArgs.h

– headers

Gets headers to send with the handshake request.
- (FMIceLinkNameValueCollection *)headers

Discussion

Gets headers to send with the handshake request.

Declared In

FMIceLinkWebSocketOpenArgs.h

– init

Creates a new instance of
- (instancetype)init

Discussion

Creates a new instance of

Declared In

FMIceLinkWebSocketOpenArgs.h

– onFailure

Gets the callback to invoke when a connection could not be established.
- (FMIceLinkAction1<FMIceLinkWebSocketOpenFailureArgs*> *)onFailure

Discussion

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

Declared In

FMIceLinkWebSocketOpenArgs.h

– onReceive

Gets the callback to invoke when a message is received.
- (FMIceLinkAction1<FMIceLinkWebSocketReceiveArgs*> *)onReceive

Discussion

Gets the callback to invoke when a message is received.

Declared In

FMIceLinkWebSocketOpenArgs.h

– onRequestCreated

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

Discussion

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

Declared In

FMIceLinkWebSocketOpenArgs.h

– onResponseReceived

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

Discussion

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

Declared In

FMIceLinkWebSocketOpenArgs.h

– onStreamFailure

Gets the callback to invoke when a successful connection breaks down.
- (FMIceLinkAction1<FMIceLinkWebSocketStreamFailureArgs*> *)onStreamFailure

Discussion

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

Declared In

FMIceLinkWebSocketOpenArgs.h

– onSuccess

Gets the callback to invoke when a successful connection has been established.
- (FMIceLinkAction1<FMIceLinkWebSocketOpenSuccessArgs*> *)onSuccess

Discussion

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

Declared In

FMIceLinkWebSocketOpenArgs.h

– sender

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

Discussion

Gets the sender of the request.

Declared In

FMIceLinkWebSocketOpenArgs.h

– setHandshakeTimeout:

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

Discussion

Sets the timeout for the handshake (in ms).

Declared In

FMIceLinkWebSocketOpenArgs.h

– setHeaders:

Sets [headers](#//api/name/headers) to send with the handshake request.
- (void)setHeaders:(FMIceLinkNameValueCollection *)value

Discussion

Sets [headers](#//api/name/headers) to send with the handshake request.

Declared In

FMIceLinkWebSocketOpenArgs.h

– setOnFailure:

Sets the callback to invoke when a connection could not be established.
- (void)setOnFailure:(FMIceLinkAction1<FMIceLinkWebSocketOpenFailureArgs*> *)value

Discussion

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

Declared In

FMIceLinkWebSocketOpenArgs.h

– setOnFailureBlock

Sets the callback to invoke when a connection could not be established.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkWebSocketOpenFailureArgs *) ))setOnFailureBlock

Discussion

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

Declared In

FMIceLinkWebSocketOpenArgs.h

– setOnFailureBlock:

Sets the callback to invoke when a connection could not be established.
- (void)setOnFailureBlock:(void ( ^ ) ( FMIceLinkWebSocketOpenFailureArgs *))valueBlock

Discussion

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

Declared In

FMIceLinkWebSocketOpenArgs.h

– setOnReceive:

Sets the callback to invoke when a message is received.
- (void)setOnReceive:(FMIceLinkAction1<FMIceLinkWebSocketReceiveArgs*> *)value

Discussion

Sets the callback to invoke when a message is received.

Declared In

FMIceLinkWebSocketOpenArgs.h

– setOnReceiveBlock

Sets the callback to invoke when a message is received.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkWebSocketReceiveArgs *) ))setOnReceiveBlock

Discussion

Sets the callback to invoke when a message is received.

Declared In

FMIceLinkWebSocketOpenArgs.h

– setOnReceiveBlock:

Sets the callback to invoke when a message is received.
- (void)setOnReceiveBlock:(void ( ^ ) ( FMIceLinkWebSocketReceiveArgs *))valueBlock

Discussion

Sets the callback to invoke when a message is received.

Declared In

FMIceLinkWebSocketOpenArgs.h

– setOnRequestCreated:

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

Discussion

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

Declared In

FMIceLinkWebSocketOpenArgs.h

– setOnRequestCreatedBlock

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

Discussion

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

Declared In

FMIceLinkWebSocketOpenArgs.h

– setOnRequestCreatedBlock:

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

Discussion

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

Declared In

FMIceLinkWebSocketOpenArgs.h

– setOnResponseReceived:

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

Discussion

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

Declared In

FMIceLinkWebSocketOpenArgs.h

– setOnResponseReceivedBlock

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

Discussion

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

Declared In

FMIceLinkWebSocketOpenArgs.h

– setOnResponseReceivedBlock:

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

Discussion

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

Declared In

FMIceLinkWebSocketOpenArgs.h

– setOnStreamFailure:

Sets the callback to invoke when a successful connection breaks down.
- (void)setOnStreamFailure:(FMIceLinkAction1<FMIceLinkWebSocketStreamFailureArgs*> *)value

Discussion

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

Declared In

FMIceLinkWebSocketOpenArgs.h

– setOnStreamFailureBlock

Sets the callback to invoke when a successful connection breaks down.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkWebSocketStreamFailureArgs *) ))setOnStreamFailureBlock

Discussion

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

Declared In

FMIceLinkWebSocketOpenArgs.h

– setOnStreamFailureBlock:

Sets the callback to invoke when a successful connection breaks down.
- (void)setOnStreamFailureBlock:(void ( ^ ) ( FMIceLinkWebSocketStreamFailureArgs *))valueBlock

Discussion

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

Declared In

FMIceLinkWebSocketOpenArgs.h

– setOnSuccess:

Sets the callback to invoke when a successful connection has been established.
- (void)setOnSuccess:(FMIceLinkAction1<FMIceLinkWebSocketOpenSuccessArgs*> *)value

Discussion

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

Declared In

FMIceLinkWebSocketOpenArgs.h

– setOnSuccessBlock

Sets the callback to invoke when a successful connection has been established.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkWebSocketOpenSuccessArgs *) ))setOnSuccessBlock

Discussion

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

Declared In

FMIceLinkWebSocketOpenArgs.h

– setOnSuccessBlock:

Sets the callback to invoke when a successful connection has been established.
- (void)setOnSuccessBlock:(void ( ^ ) ( FMIceLinkWebSocketOpenSuccessArgs *))valueBlock

Discussion

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

Declared In

FMIceLinkWebSocketOpenArgs.h

– setSender:

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

Discussion

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

Declared In

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

FMIceLinkWebSocketOpenArgs.h

– streamTimeout

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

Discussion

Gets the timeout for the stream (in ms).

Declared In

FMIceLinkWebSocketOpenArgs.h

+ webSocketOpenArgs

Creates a new instance of
+ (FMIceLinkWebSocketOpenArgs *)webSocketOpenArgs

Discussion

Creates a new instance of

Declared In

FMIceLinkWebSocketOpenArgs.h