FMWebSyncBaseClient Class Reference

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

Overview

Base class for WebSync clients and publishers.

– addOnHttpRequestCreatedWithValue:

Adds a handler that is raised whenever an underlying HTTP request has been created and is about to be transferred to the server. This is a good place to add headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

- (FMCallback *)addOnHttpRequestCreatedWithValue:(FMCallback *)value

Discussion

Adds a handler that is raised whenever an underlying HTTP request has been created and is about to be transferred to the server. This is a good place to add headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

Declared In

FMWebSync.h

– addOnHttpRequestCreated:

Adds a handler that is raised whenever an underlying HTTP request has been created and is about to be transferred to the server. This is a good place to add headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

- (FMCallback *)addOnHttpRequestCreated:(FMCallback *)value

Discussion

Adds a handler that is raised whenever an underlying HTTP request has been created and is about to be transferred to the server. This is a good place to add headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

Declared In

FMWebSync.h

– addOnHttpRequestCreatedWithValueBlock:

Adds a handler that is raised whenever an underlying HTTP request has been created and is about to be transferred to the server. This is a good place to add headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

- (FMCallback *)addOnHttpRequestCreatedWithValueBlock:(void ( ^ ) ( FMHttpRequestCreatedArgs *))valueBlock

Discussion

Adds a handler that is raised whenever an underlying HTTP request has been created and is about to be transferred to the server. This is a good place to add headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

Declared In

FMWebSync.h

– addOnHttpRequestCreatedBlock:

Adds a handler that is raised whenever an underlying HTTP request has been created and is about to be transferred to the server. This is a good place to add headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

- (FMCallback *)addOnHttpRequestCreatedBlock:(void ( ^ ) ( FMHttpRequestCreatedArgs *))valueBlock

Discussion

Adds a handler that is raised whenever an underlying HTTP request has been created and is about to be transferred to the server. This is a good place to add headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

Declared In

FMWebSync.h

– addOnHttpResponseReceivedWithValue:

Adds a handler that is raised whenever an underlying HTTP response has been received and is about to be processed by the client. This is a good place to read headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

- (FMCallback *)addOnHttpResponseReceivedWithValue:(FMCallback *)value

Discussion

Adds a handler that is raised whenever an underlying HTTP response has been received and is about to be processed by the client. This is a good place to read headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

Declared In

FMWebSync.h

– addOnHttpResponseReceived:

Adds a handler that is raised whenever an underlying HTTP response has been received and is about to be processed by the client. This is a good place to read headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

- (FMCallback *)addOnHttpResponseReceived:(FMCallback *)value

Discussion

Adds a handler that is raised whenever an underlying HTTP response has been received and is about to be processed by the client. This is a good place to read headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

Declared In

FMWebSync.h

– addOnHttpResponseReceivedWithValueBlock:

Adds a handler that is raised whenever an underlying HTTP response has been received and is about to be processed by the client. This is a good place to read headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

- (FMCallback *)addOnHttpResponseReceivedWithValueBlock:(void ( ^ ) ( FMHttpResponseReceivedArgs *))valueBlock

Discussion

Adds a handler that is raised whenever an underlying HTTP response has been received and is about to be processed by the client. This is a good place to read headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

Declared In

FMWebSync.h

– addOnHttpResponseReceivedBlock:

Adds a handler that is raised whenever an underlying HTTP response has been received and is about to be processed by the client. This is a good place to read headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

- (FMCallback *)addOnHttpResponseReceivedBlock:(void ( ^ ) ( FMHttpResponseReceivedArgs *))valueBlock

Discussion

Adds a handler that is raised whenever an underlying HTTP response has been received and is about to be processed by the client. This is a good place to read headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

Declared In

FMWebSync.h

– addOnRequestCreatedWithValue:

Adds a handler that is raised whenever a new request is created and about to be transferred to the server. This is a good place to read or modify outgoing messages.

- (FMCallback *)addOnRequestCreatedWithValue:(FMCallback *)value

Discussion

Adds a handler that is raised whenever a new request is created and about to be transferred to the server. This is a good place to read or modify outgoing messages.

Declared In

FMWebSync.h

– addOnRequestCreated:

Adds a handler that is raised whenever a new request is created and about to be transferred to the server. This is a good place to read or modify outgoing messages.

- (FMCallback *)addOnRequestCreated:(FMCallback *)value

Discussion

Adds a handler that is raised whenever a new request is created and about to be transferred to the server. This is a good place to read or modify outgoing messages.

Declared In

FMWebSync.h

– addOnRequestCreatedWithValueBlock:

Adds a handler that is raised whenever a new request is created and about to be transferred to the server. This is a good place to read or modify outgoing messages.

- (FMCallback *)addOnRequestCreatedWithValueBlock:(void ( ^ ) ( FMWebSyncMessageRequestCreatedArgs *))valueBlock

Discussion

Adds a handler that is raised whenever a new request is created and about to be transferred to the server. This is a good place to read or modify outgoing messages.

Declared In

FMWebSync.h

– addOnRequestCreatedBlock:

Adds a handler that is raised whenever a new request is created and about to be transferred to the server. This is a good place to read or modify outgoing messages.

- (FMCallback *)addOnRequestCreatedBlock:(void ( ^ ) ( FMWebSyncMessageRequestCreatedArgs *))valueBlock

Discussion

Adds a handler that is raised whenever a new request is created and about to be transferred to the server. This is a good place to read or modify outgoing messages.

Declared In

FMWebSync.h

– addOnResponseReceivedWithValue:

Adds a handler that is raised whenever a new response is received and about to be processed by the client. This is a good place to read or modify incoming messages.

- (FMCallback *)addOnResponseReceivedWithValue:(FMCallback *)value

Discussion

Adds a handler that is raised whenever a new response is received and about to be processed by the client. This is a good place to read or modify incoming messages.

Declared In

FMWebSync.h

– addOnResponseReceived:

Adds a handler that is raised whenever a new response is received and about to be processed by the client. This is a good place to read or modify incoming messages.

- (FMCallback *)addOnResponseReceived:(FMCallback *)value

Discussion

Adds a handler that is raised whenever a new response is received and about to be processed by the client. This is a good place to read or modify incoming messages.

Declared In

FMWebSync.h

– addOnResponseReceivedWithValueBlock:

Adds a handler that is raised whenever a new response is received and about to be processed by the client. This is a good place to read or modify incoming messages.

- (FMCallback *)addOnResponseReceivedWithValueBlock:(void ( ^ ) ( FMWebSyncMessageResponseReceivedArgs *))valueBlock

Discussion

Adds a handler that is raised whenever a new response is received and about to be processed by the client. This is a good place to read or modify incoming messages.

Declared In

FMWebSync.h

– addOnResponseReceivedBlock:

Adds a handler that is raised whenever a new response is received and about to be processed by the client. This is a good place to read or modify incoming messages.

- (FMCallback *)addOnResponseReceivedBlock:(void ( ^ ) ( FMWebSyncMessageResponseReceivedArgs *))valueBlock

Discussion

Adds a handler that is raised whenever a new response is received and about to be processed by the client. This is a good place to read or modify incoming messages.

Declared In

FMWebSync.h

– addOnUnhandledExceptionWithValue:

Adds a handler that is raised when an exception is thrown in user code and not handled, typically in a callback or event handler.

- (FMCallback *)addOnUnhandledExceptionWithValue:(FMCallback *)value

Discussion

Adds a handler that is raised when an exception is thrown in user code and not handled, typically in a callback or event handler.

Declared In

FMWebSync.h

– addOnUnhandledException:

Adds a handler that is raised when an exception is thrown in user code and not handled, typically in a callback or event handler.

- (FMCallback *)addOnUnhandledException:(FMCallback *)value

Discussion

Adds a handler that is raised when an exception is thrown in user code and not handled, typically in a callback or event handler.

Declared In

FMWebSync.h

– addOnUnhandledExceptionWithValueBlock:

Adds a handler that is raised when an exception is thrown in user code and not handled, typically in a callback or event handler.

- (FMCallback *)addOnUnhandledExceptionWithValueBlock:(void ( ^ ) ( FMWebSyncUnhandledExceptionArgs *))valueBlock

Discussion

Adds a handler that is raised when an exception is thrown in user code and not handled, typically in a callback or event handler.

Declared In

FMWebSync.h

– addOnUnhandledExceptionBlock:

Adds a handler that is raised when an exception is thrown in user code and not handled, typically in a callback or event handler.

- (FMCallback *)addOnUnhandledExceptionBlock:(void ( ^ ) ( FMWebSyncUnhandledExceptionArgs *))valueBlock

Discussion

Adds a handler that is raised when an exception is thrown in user code and not handled, typically in a callback or event handler.

Declared In

FMWebSync.h

+ baseClient

Initializes a new instance of the class.

+ (FMWebSyncBaseClient *)baseClient

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– concurrencyMode

Gets a flag indicating the level of concurrency in the current process. The intended use of this property is to lighten the processor load when hundreds or thousands of instances are created in a single process for the purposes of generating load for testing.

- (FMWebSyncConcurrencyMode)concurrencyMode

Discussion

Gets a flag indicating the level of concurrency in the current process. The intended use of this property is to lighten the processor load when hundreds or thousands of instances are created in a single process for the purposes of generating load for testing.

Declared In

FMWebSync.h

– createHeaders

Creates an initial set of headers, including the domain key and domain name.

- (FMNameValueCollection *)createHeaders

Discussion

Creates an initial set of headers, including the domain key and domain name.

Declared In

FMWebSync.h

– disableBinary

Gets whether to disable the transmission of binary payloads as binary on the wire. If set to true, binary payloads will be sent over the wire as base64-encoded strings.

- (bool)disableBinary

Discussion

Gets whether to disable the transmission of binary payloads as binary on the wire. If set to true, binary payloads will be sent over the wire as base64-encoded strings.

Declared In

FMWebSync.h

– domainKey

Gets the domain key for sandboxing connections to the server. Defaults to “11111111-1111-1111-1111-111111111111”. If you are using WebSync On-Demand, this should be set to the private domain key if you are attempting to use methods that have been secured in the Portal; otherwise, use the public domain key.

- (FMGuid *)domainKey

Discussion

Gets the domain key for sandboxing connections to the server. Defaults to “11111111-1111-1111-1111-111111111111”. If you are using WebSync On-Demand, this should be set to the private domain key if you are attempting to use methods that have been secured in the Portal; otherwise, use the public domain key.

Declared In

FMWebSync.h

– domainKeyString

Gets the as a string value.

- (NSString *)domainKeyString

Discussion

Gets the as a string value.

Declared In

FMWebSync.h

– domainName

Gets the domain name to send as the Referrer with each request. Defaults to “localhost”. If you are using WebSync On-Demand, this field is only necessary if you are using the public domain key, in which case it should be set to equal the domain name entered in the Portal for the domain key (e.g. “frozenmountain.com”).

- (NSString *)domainName

Discussion

Gets the domain name to send as the Referrer with each request. Defaults to “localhost”. If you are using WebSync On-Demand, this field is only necessary if you are using the public domain key, in which case it should be set to equal the domain name entered in the Portal for the domain key (e.g. “frozenmountain.com”).

Declared In

FMWebSync.h

– init

Initializes a new instance of the class.

- (id)init

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– raiseUnhandledExceptionWithException:

Raises an unhandled exception.

- (bool)raiseUnhandledExceptionWithException:(NSException *)exception

Parameters

name="exception">The

unhandled exception. true if the exception was handled; otherwise, false.

Discussion

Raises an unhandled exception.

Declared In

FMWebSync.h

– raiseUnhandledException:

Raises an unhandled exception.

- (bool)raiseUnhandledException:(NSException *)exception

Parameters

name="exception">The

unhandled exception. true if the exception was handled; otherwise, false.

Discussion

Raises an unhandled exception.

Declared In

FMWebSync.h

– removeOnHttpRequestCreatedWithValue:

Removes a handler that is raised whenever an underlying HTTP request has been created and is about to be transferred to the server. This is a good place to add headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

- (void)removeOnHttpRequestCreatedWithValue:(FMCallback *)value

Discussion

Removes a handler that is raised whenever an underlying HTTP request has been created and is about to be transferred to the server. This is a good place to add headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

Declared In

FMWebSync.h

– removeOnHttpRequestCreated:

Removes a handler that is raised whenever an underlying HTTP request has been created and is about to be transferred to the server. This is a good place to add headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

- (void)removeOnHttpRequestCreated:(FMCallback *)value

Discussion

Removes a handler that is raised whenever an underlying HTTP request has been created and is about to be transferred to the server. This is a good place to add headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

Declared In

FMWebSync.h

– removeOnHttpResponseReceivedWithValue:

Removes a handler that is raised whenever an underlying HTTP response has been received and is about to be processed by the client. This is a good place to read headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

- (void)removeOnHttpResponseReceivedWithValue:(FMCallback *)value

Discussion

Removes a handler that is raised whenever an underlying HTTP response has been received and is about to be processed by the client. This is a good place to read headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

Declared In

FMWebSync.h

– removeOnHttpResponseReceived:

Removes a handler that is raised whenever an underlying HTTP response has been received and is about to be processed by the client. This is a good place to read headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

- (void)removeOnHttpResponseReceived:(FMCallback *)value

Discussion

Removes a handler that is raised whenever an underlying HTTP response has been received and is about to be processed by the client. This is a good place to read headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

Declared In

FMWebSync.h

– removeOnRequestCreatedWithValue:

Removes a handler that is raised whenever a new request is created and about to be transferred to the server. This is a good place to read or modify outgoing messages.

- (void)removeOnRequestCreatedWithValue:(FMCallback *)value

Discussion

Removes a handler that is raised whenever a new request is created and about to be transferred to the server. This is a good place to read or modify outgoing messages.

Declared In

FMWebSync.h

– removeOnRequestCreated:

Removes a handler that is raised whenever a new request is created and about to be transferred to the server. This is a good place to read or modify outgoing messages.

- (void)removeOnRequestCreated:(FMCallback *)value

Discussion

Removes a handler that is raised whenever a new request is created and about to be transferred to the server. This is a good place to read or modify outgoing messages.

Declared In

FMWebSync.h

– removeOnResponseReceivedWithValue:

Removes a handler that is raised whenever a new response is received and about to be processed by the client. This is a good place to read or modify incoming messages.

- (void)removeOnResponseReceivedWithValue:(FMCallback *)value

Discussion

Removes a handler that is raised whenever a new response is received and about to be processed by the client. This is a good place to read or modify incoming messages.

Declared In

FMWebSync.h

– removeOnResponseReceived:

Removes a handler that is raised whenever a new response is received and about to be processed by the client. This is a good place to read or modify incoming messages.

- (void)removeOnResponseReceived:(FMCallback *)value

Discussion

Removes a handler that is raised whenever a new response is received and about to be processed by the client. This is a good place to read or modify incoming messages.

Declared In

FMWebSync.h

– removeOnUnhandledExceptionWithValue:

Removes a handler that is raised when an exception is thrown in user code and not handled, typically in a callback or event handler.

- (void)removeOnUnhandledExceptionWithValue:(FMCallback *)value

Discussion

Removes a handler that is raised when an exception is thrown in user code and not handled, typically in a callback or event handler.

Declared In

FMWebSync.h

– removeOnUnhandledException:

Removes a handler that is raised when an exception is thrown in user code and not handled, typically in a callback or event handler.

- (void)removeOnUnhandledException:(FMCallback *)value

Discussion

Removes a handler that is raised when an exception is thrown in user code and not handled, typically in a callback or event handler.

Declared In

FMWebSync.h

– requestTimeout

Gets the number of milliseconds to wait for a standard request to return a response before it is aborted and another request is attempted. Defaults to 15000 (15 seconds).

- (int)requestTimeout

Discussion

Gets the number of milliseconds to wait for a standard request to return a response before it is aborted and another request is attempted. Defaults to 15000 (15 seconds).

Declared In

FMWebSync.h

– requestUrl

Gets the absolute URL of the WebSync request handler, typically ending with websync.ashx.

- (NSString *)requestUrl

Discussion

Gets the absolute URL of the WebSync request handler, typically ending with websync.ashx.

Declared In

FMWebSync.h

– setConcurrencyMode:

Sets a flag indicating the level of concurrency in the current process. The intended use of this property is to lighten the processor load when hundreds or thousands of instances are created in a single process for the purposes of generating load for testing.

- (void)setConcurrencyMode:(FMWebSyncConcurrencyMode)value

Discussion

Sets a flag indicating the level of concurrency in the current process. The intended use of this property is to lighten the processor load when hundreds or thousands of instances are created in a single process for the purposes of generating load for testing.

Declared In

FMWebSync.h

– setDisableBinary:

Sets whether to disable the transmission of binary payloads as binary on the wire. If set to true, binary payloads will be sent over the wire as base64-encoded strings.

- (void)setDisableBinary:(bool)value

Discussion

Sets whether to disable the transmission of binary payloads as binary on the wire. If set to true, binary payloads will be sent over the wire as base64-encoded strings.

Declared In

FMWebSync.h

– setDomainKey:

Sets the domain key for sandboxing connections to the server. Defaults to “11111111-1111-1111-1111-111111111111”. If you are using WebSync On-Demand, this should be set to the private domain key if you are attempting to use methods that have been secured in the Portal; otherwise, use the public domain key.

- (void)setDomainKey:(FMGuid *)value

Discussion

Sets the domain key for sandboxing connections to the server. Defaults to “11111111-1111-1111-1111-111111111111”. If you are using WebSync On-Demand, this should be set to the private domain key if you are attempting to use methods that have been secured in the Portal; otherwise, use the public domain key.

Declared In

FMWebSync.h

– setDomainKeyString:

Sets the as a string value.

- (void)setDomainKeyString:(NSString *)value

Discussion

Sets the as a string value.

Declared In

FMWebSync.h

– setDomainName:

Sets the domain name to send as the Referrer with each request. Defaults to “localhost”. If you are using WebSync On-Demand, this field is only necessary if you are using the public domain key, in which case it should be set to equal the domain name entered in the Portal for the domain key (e.g. “frozenmountain.com”).

- (void)setDomainName:(NSString *)value

Discussion

Sets the domain name to send as the Referrer with each request. Defaults to “localhost”. If you are using WebSync On-Demand, this field is only necessary if you are using the public domain key, in which case it should be set to equal the domain name entered in the Portal for the domain key (e.g. “frozenmountain.com”).

Declared In

FMWebSync.h

– setRequestTimeout:

Sets the number of milliseconds to wait for a standard request to return a response before it is aborted and another request is attempted. Defaults to 15000 (15 seconds).

- (void)setRequestTimeout:(int)value

Discussion

Sets the number of milliseconds to wait for a standard request to return a response before it is aborted and another request is attempted. Defaults to 15000 (15 seconds).

Declared In

FMWebSync.h

– setRequestUrl:

Sets the absolute URL of the WebSync request handler, typically ending with websync.ashx.

- (void)setRequestUrl:(NSString *)value

Discussion

Sets the absolute URL of the WebSync request handler, typically ending with websync.ashx.

Declared In

FMWebSync.h