FMWebSyncConnectArgs Class Reference

Inherits from	FMWebSyncBaseInputArgs : FMWebSyncExtensible : FMDynamic : FMSerializable : NSObject
Declared in	FMWebSync.h

`+ connectArgs`

Creates a new instance of .

+ (FMWebSyncConnectArgs *)connectArgs

Discussion

Creates a new instance of .

Declared In

FMWebSync.h

`– init`

Creates a new instance of .

- (id)init

Discussion

Creates a new instance of .

Declared In

FMWebSync.h

`– onComplete`

Gets the callback to invoke after or .

- (FMCallback *)onComplete

Discussion

Gets the callback to invoke after or .

Declared In

FMWebSync.h

`– onFailure`

Gets the callback to invoke if the request fails.

- (FMCallback *)onFailure

Discussion

Gets the callback to invoke if the request fails.

Declared In

FMWebSync.h

`– onStateRestored`

Gets the callback to invoke after all bindings and subscriptions are restored following a reconnect. See for callback argument details.

- (FMCallback *)onStateRestored

Discussion

Gets the callback to invoke after all bindings and subscriptions are restored following a reconnect. See for callback argument details.

Declared In

FMWebSync.h

`– onStreamFailure`

Gets the callback to invoke if the streaming connection fails. See for callback argument details.

This method will be invoked if the connection was lost or the client record no longer exists on the server (either due to network loss or an application pool recycle). In either case, the client will automatically reconnect after firing this callback. If the reconnect succeeds, the OnSuccess callback will be invoked with set to true. If the reconnect succeeds, the OnFailure callback will be invoked with set to true. This is the recommended place to perform any UI updates necessary to inform the application user that the connection has been temporarily lost. Any UI components shown by this callback can be hidden in either OnSuccess or OnFailure.

- (FMCallback *)onStreamFailure

Discussion

Gets the callback to invoke if the streaming connection fails. See for callback argument details.

This method will be invoked if the connection was lost or the client record no longer exists on the server (either due to network loss or an application pool recycle). In either case, the client will automatically reconnect after firing this callback. If the reconnect succeeds, the OnSuccess callback will be invoked with set to true. If the reconnect succeeds, the OnFailure callback will be invoked with set to true. This is the recommended place to perform any UI updates necessary to inform the application user that the connection has been temporarily lost. Any UI components shown by this callback can be hidden in either OnSuccess or OnFailure.

Declared In

FMWebSync.h

`– onSuccess`

Gets the callback to invoke if the request succeeds.

- (FMCallback *)onSuccess

Discussion

Gets the callback to invoke if the request succeeds.

Declared In

FMWebSync.h

`– retryBackoff`

Gets the backoff algorithm to use when retrying a failed connect handshake. Used to calculate the sleep timeout before retrying if is set to true in . The function should return the desired timeout in milliseconds.

- (FMCallback *)retryBackoff

Discussion

Gets the backoff algorithm to use when retrying a failed connect handshake. Used to calculate the sleep timeout before retrying if is set to true in . The function should return the desired timeout in milliseconds.

Declared In

FMWebSync.h

`– retryMode`

Gets the mode under which the client is expected to operate when a connect handshake fails. This property controls the default value of

- (FMWebSyncConnectRetryMode)retryMode

Discussion

Gets the mode under which the client is expected to operate when a connect handshake fails. This property controls the default value of

Declared In

FMWebSync.h

`– setOnComplete:`

Sets the callback to invoke after or .

- (void)setOnComplete:(FMCallback *)value

Discussion

Sets the callback to invoke after or .

Declared In

FMWebSync.h

`– setOnCompleteBlock:`

Sets the callback to invoke after or .

- (void)setOnCompleteBlock:(void ( ^ ) ( FMWebSyncConnectCompleteArgs *))valueBlock

Discussion

Sets the callback to invoke after or .

Declared In

FMWebSync.h

`– setOnFailure:`

Sets the callback to invoke if the request fails.

- (void)setOnFailure:(FMCallback *)value

Discussion

Sets the callback to invoke if the request fails.

Declared In

FMWebSync.h

`– setOnFailureBlock:`

Sets the callback to invoke if the request fails.

- (void)setOnFailureBlock:(void ( ^ ) ( FMWebSyncConnectFailureArgs *))valueBlock

Discussion

Sets the callback to invoke if the request fails.

Declared In

FMWebSync.h

`– setOnStateRestored:`

Sets the callback to invoke after all bindings and subscriptions are restored following a reconnect. See for callback argument details.

- (void)setOnStateRestored:(FMCallback *)value

Discussion

Sets the callback to invoke after all bindings and subscriptions are restored following a reconnect. See for callback argument details.

Declared In

FMWebSync.h

`– setOnStateRestoredBlock:`

Sets the callback to invoke after all bindings and subscriptions are restored following a reconnect. See for callback argument details.

- (void)setOnStateRestoredBlock:(void ( ^ ) ( FMWebSyncStateRestoredArgs *))valueBlock

Discussion

Sets the callback to invoke after all bindings and subscriptions are restored following a reconnect. See for callback argument details.

Declared In

FMWebSync.h

`– setOnStreamFailure:`

Sets the callback to invoke if the streaming connection fails. See for callback argument details.

This method will be invoked if the connection was lost or the client record no longer exists on the server (either due to network loss or an application pool recycle). In either case, the client will automatically reconnect after firing this callback. If the reconnect succeeds, the OnSuccess callback will be invoked with set to true. If the reconnect succeeds, the OnFailure callback will be invoked with set to true. This is the recommended place to perform any UI updates necessary to inform the application user that the connection has been temporarily lost. Any UI components shown by this callback can be hidden in either OnSuccess or OnFailure.

- (void)setOnStreamFailure:(FMCallback *)value

Discussion

Sets the callback to invoke if the streaming connection fails. See for callback argument details.

This method will be invoked if the connection was lost or the client record no longer exists on the server (either due to network loss or an application pool recycle). In either case, the client will automatically reconnect after firing this callback. If the reconnect succeeds, the OnSuccess callback will be invoked with set to true. If the reconnect succeeds, the OnFailure callback will be invoked with set to true. This is the recommended place to perform any UI updates necessary to inform the application user that the connection has been temporarily lost. Any UI components shown by this callback can be hidden in either OnSuccess or OnFailure.

Declared In

FMWebSync.h

`– setOnStreamFailureBlock:`

Sets the callback to invoke if the streaming connection fails. See for callback argument details.

This method will be invoked if the connection was lost or the client record no longer exists on the server (either due to network loss or an application pool recycle). In either case, the client will automatically reconnect after firing this callback. If the reconnect succeeds, the OnSuccess callback will be invoked with set to true. If the reconnect succeeds, the OnFailure callback will be invoked with set to true. This is the recommended place to perform any UI updates necessary to inform the application user that the connection has been temporarily lost. Any UI components shown by this callback can be hidden in either OnSuccess or OnFailure.

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

Discussion

Sets the callback to invoke if the streaming connection fails. See for callback argument details.

This method will be invoked if the connection was lost or the client record no longer exists on the server (either due to network loss or an application pool recycle). In either case, the client will automatically reconnect after firing this callback. If the reconnect succeeds, the OnSuccess callback will be invoked with set to true. If the reconnect succeeds, the OnFailure callback will be invoked with set to true. This is the recommended place to perform any UI updates necessary to inform the application user that the connection has been temporarily lost. Any UI components shown by this callback can be hidden in either OnSuccess or OnFailure.

Declared In

FMWebSync.h

`– setOnSuccess:`

Sets the callback to invoke if the request succeeds.

- (void)setOnSuccess:(FMCallback *)value

Discussion

Sets the callback to invoke if the request succeeds.

Declared In

FMWebSync.h

`– setOnSuccessBlock:`

Sets the callback to invoke if the request succeeds.

- (void)setOnSuccessBlock:(void ( ^ ) ( FMWebSyncConnectSuccessArgs *))valueBlock

Discussion

Sets the callback to invoke if the request succeeds.

Declared In

FMWebSync.h

`– setRetryBackoff:`

Sets the backoff algorithm to use when retrying a failed connect handshake. Used to calculate the sleep timeout before retrying if is set to true in . The function should return the desired timeout in milliseconds.

- (void)setRetryBackoff:(FMCallback *)value

Discussion

Sets the backoff algorithm to use when retrying a failed connect handshake. Used to calculate the sleep timeout before retrying if is set to true in . The function should return the desired timeout in milliseconds.

Declared In

FMWebSync.h

`– setRetryMode:`

Sets the mode under which the client is expected to operate when a connect handshake fails. This property controls the default value of

- (void)setRetryMode:(FMWebSyncConnectRetryMode)value

Discussion

Sets the mode under which the client is expected to operate when a connect handshake fails. This property controls the default value of

Declared In

FMWebSync.h

FMWebSyncConnectArgs Class Reference

Overview

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In