FMWebSyncWebSocketMessageTransfer Class Reference

Inherits from FMWebSyncMessageTransfer : NSObject
Declared in FMWebSync.h

Overview

Base class that defines methods for transferring messages over HTTP.

– handshakeTimeout

Gets the timeout for the initial handshake.

- (int)handshakeTimeout

Discussion

Gets the timeout for the initial handshake.

Declared In

FMWebSync.h

– initWithUrl:

Initializes a new instance of the class.

- (id)initWithUrl:(NSString *)url

Parameters

name="url">The

URL.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– onOpenFailure

Gets the callback to invoke if the handshake fails.

- (FMCallback *)onOpenFailure

Discussion

Gets the callback to invoke if the handshake fails.

Declared In

FMWebSync.h

– onOpenSuccess

Gets the callback to invoke if the handshake succeeds.

- (FMCallback *)onOpenSuccess

Discussion

Gets the callback to invoke if the handshake succeeds.

Declared In

FMWebSync.h

– onRequestCreated

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

- (FMCallback *)onRequestCreated

Discussion

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

Declared In

FMWebSync.h

– onResponseReceived

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

- (FMCallback *)onResponseReceived

Discussion

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

Declared In

FMWebSync.h

– onStreamFailure

Gets the callback to invoke if the stream errors out.

- (FMCallback *)onStreamFailure

Discussion

Gets the callback to invoke if the stream errors out.

Declared In

FMWebSync.h

– openWithHeaders:

Opens the socket.

- (void)openWithHeaders:(FMNameValueCollection *)headers

Parameters

name="headers">The

headers to pass in with the initial handshake.

Discussion

Opens the socket.

Declared In

FMWebSync.h

– sender

Gets the sender of the messages.

- (NSObject *)sender

Discussion

Gets the sender of the messages.

Declared In

FMWebSync.h

– sendMessagesAsyncWithRequestArgs:callback:

Sends a request asynchronously.

- (void)sendMessagesAsyncWithRequestArgs:(FMWebSyncMessageRequestArgs *)requestArgs callback:(FMCallback *)callback

Parameters

name="requestArgs">The

request parameters.
name="callback">The

callback to execute with the response parameters.

Discussion

Sends a request asynchronously.

Declared In

FMWebSync.h

– sendMessagesAsyncWithRequestArgs:callbackBlock:

Sends a request asynchronously.

- (void)sendMessagesAsyncWithRequestArgs:(FMWebSyncMessageRequestArgs *)requestArgs callbackBlock:(void ( ^ ) ( FMWebSyncMessageResponseArgs *))callbackBlock

Parameters

name="requestArgs">The

request parameters.
name="callback">The

callback to execute with the response parameters.

Discussion

Sends a request asynchronously.

Declared In

FMWebSync.h

– sendMessagesWithRequestArgs:

Sends a request synchronously.

- (FMWebSyncMessageResponseArgs *)sendMessagesWithRequestArgs:(FMWebSyncMessageRequestArgs *)requestArgs

Parameters

name="requestArgs">The

request parameters. The response parameters.

Discussion

Sends a request synchronously.

Declared In

FMWebSync.h

– setHandshakeTimeout:

Sets the timeout for the initial handshake.

- (void)setHandshakeTimeout:(int)value

Discussion

Sets the timeout for the initial handshake.

Declared In

FMWebSync.h

– setOnOpenFailure:

Sets the callback to invoke if the handshake fails.

- (void)setOnOpenFailure:(FMCallback *)value

Discussion

Sets the callback to invoke if the handshake fails.

Declared In

FMWebSync.h

– setOnOpenFailureBlock:

Sets the callback to invoke if the handshake fails.

- (void)setOnOpenFailureBlock:(void ( ^ ) ( FMWebSocketOpenFailureArgs *))valueBlock

Discussion

Sets the callback to invoke if the handshake fails.

Declared In

FMWebSync.h

– setOnOpenSuccess:

Sets the callback to invoke if the handshake succeeds.

- (void)setOnOpenSuccess:(FMCallback *)value

Discussion

Sets the callback to invoke if the handshake succeeds.

Declared In

FMWebSync.h

– setOnOpenSuccessBlock:

Sets the callback to invoke if the handshake succeeds.

- (void)setOnOpenSuccessBlock:(void ( ^ ) ( FMWebSocketOpenSuccessArgs *))valueBlock

Discussion

Sets the callback to invoke if the handshake succeeds.

Declared In

FMWebSync.h

– setOnRequestCreated:

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

- (void)setOnRequestCreated:(FMCallback *)value

Discussion

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

Declared In

FMWebSync.h

– setOnRequestCreatedBlock:

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

- (void)setOnRequestCreatedBlock:(void ( ^ ) ( FMHttpRequestCreatedArgs *))valueBlock

Discussion

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

Declared In

FMWebSync.h

– setOnResponseReceived:

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

- (void)setOnResponseReceived:(FMCallback *)value

Discussion

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

Declared In

FMWebSync.h

– setOnResponseReceivedBlock:

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

- (void)setOnResponseReceivedBlock:(void ( ^ ) ( FMHttpResponseReceivedArgs *))valueBlock

Discussion

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

Declared In

FMWebSync.h

– setOnStreamFailure:

Sets the callback to invoke if the stream errors out.

- (void)setOnStreamFailure:(FMCallback *)value

Discussion

Sets the callback to invoke if the stream errors out.

Declared In

FMWebSync.h

– setOnStreamFailureBlock:

Sets the callback to invoke if the stream errors out.

- (void)setOnStreamFailureBlock:(void ( ^ ) ( FMWebSocketStreamFailureArgs *))valueBlock

Discussion

Sets the callback to invoke if the stream errors out.

Declared In

FMWebSync.h

– setSender:

Sets the sender of the messages.

- (void)setSender:(NSObject *)value

Discussion

Sets the sender of the messages.

Declared In

FMWebSync.h

– setStreamTimeout:

Sets the timeout for the stream.

- (void)setStreamTimeout:(int)value

Discussion

Sets the timeout for the stream.

Declared In

FMWebSync.h

– setUrl:

Sets the URL.

- (void)setUrl:(NSString *)value

Discussion

Sets the URL.

Declared In

FMWebSync.h

– shutdown

Releases any resources and shuts down.

- (void)shutdown

Discussion

Releases any resources and shuts down.

Declared In

FMWebSync.h

– streamTimeout

Gets the timeout for the stream.

- (int)streamTimeout

Discussion

Gets the timeout for the stream.

Declared In

FMWebSync.h

– url

Gets the URL.

- (NSString *)url

Discussion

Gets the URL.

Declared In

FMWebSync.h

+ webSocketMessageTransferWithUrl:

Initializes a new instance of the class.

+ (FMWebSyncWebSocketMessageTransfer *)webSocketMessageTransferWithUrl:(NSString *)url

Parameters

name="url">The

URL.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h