FMWebSyncPublisherQueue Class Reference

Inherits from NSObject
Declared in FMWebSync.h

Overview

A thread-safe publisher queue that ensures synchronous delivery of publications from anywhere in your application while optimizing network resource consumption.

– addExceptionWithValue:

Adds a handler that is raised when an exception is thrown while publishing.

- (FMCallback *)addExceptionWithValue:(FMCallback *)value

Discussion

Adds a handler that is raised when an exception is thrown while publishing.

Declared In

FMWebSync.h

– addException:

Adds a handler that is raised when an exception is thrown while publishing.

- (FMCallback *)addException:(FMCallback *)value

Discussion

Adds a handler that is raised when an exception is thrown while publishing.

Declared In

FMWebSync.h

– addExceptionWithValueBlock:

Adds a handler that is raised when an exception is thrown while publishing.

- (FMCallback *)addExceptionWithValueBlock:(void ( ^ ) ( NSException *))valueBlock

Discussion

Adds a handler that is raised when an exception is thrown while publishing.

Declared In

FMWebSync.h

– addExceptionBlock:

Adds a handler that is raised when an exception is thrown while publishing.

- (FMCallback *)addExceptionBlock:(void ( ^ ) ( NSException *))valueBlock

Discussion

Adds a handler that is raised when an exception is thrown while publishing.

Declared In

FMWebSync.h

– addPublicationWithPublication:

Adds a publication to the queue.

- (void)addPublicationWithPublication:(FMWebSyncPublication *)publication

Parameters

name="publication">The

publication to add.

Discussion

Adds a publication to the queue.

Declared In

FMWebSync.h

– addPublication:

Adds a publication to the queue.

- (void)addPublication:(FMWebSyncPublication *)publication

Parameters

name="publication">The

publication to add.

Discussion

Adds a publication to the queue.

Declared In

FMWebSync.h

– addPublishedWithValue:

Adds a handler that is raised immediately after a Publish call has been made.

- (FMCallback *)addPublishedWithValue:(FMCallback *)value

Discussion

Adds a handler that is raised immediately after a Publish call has been made.

Declared In

FMWebSync.h

– addPublished:

Adds a handler that is raised immediately after a Publish call has been made.

- (FMCallback *)addPublished:(FMCallback *)value

Discussion

Adds a handler that is raised immediately after a Publish call has been made.

Declared In

FMWebSync.h

– initWithPublisher:

Initializes a new instance of the class.

- (id)initWithPublisher:(FMWebSyncPublisher *)publisher

Parameters

name="publisher">The

publisher to use for sending messages to the WebSync server.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– maxBatchSize

Gets the maximum number of publications that will be transferred to a server in one HTTP request. A MaxBatchSize of 0 or less will remove the maximum limit, and all queued publications will be sent every time. Defaults to 1000.

- (int)maxBatchSize

Discussion

Gets the maximum number of publications that will be transferred to a server in one HTTP request. A MaxBatchSize of 0 or less will remove the maximum limit, and all queued publications will be sent every time. Defaults to 1000.

Declared In

FMWebSync.h

– publisher

Gets the used by the queue.

- (FMWebSyncPublisher *)publisher

Discussion

Gets the used by the queue.

Declared In

FMWebSync.h

+ publisherQueueWithPublisher:

Initializes a new instance of the class.

+ (FMWebSyncPublisherQueue *)publisherQueueWithPublisher:(FMWebSyncPublisher *)publisher

Parameters

name="publisher">The

publisher to use for sending messages to the WebSync server.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– removeExceptionWithValue:

Removes a handler that is raised when an exception is thrown while publishing.

- (void)removeExceptionWithValue:(FMCallback *)value

Discussion

Removes a handler that is raised when an exception is thrown while publishing.

Declared In

FMWebSync.h

– removeException:

Removes a handler that is raised when an exception is thrown while publishing.

- (void)removeException:(FMCallback *)value

Discussion

Removes a handler that is raised when an exception is thrown while publishing.

Declared In

FMWebSync.h

– removePublishedWithValue:

Removes a handler that is raised immediately after a Publish call has been made.

- (void)removePublishedWithValue:(FMCallback *)value

Discussion

Removes a handler that is raised immediately after a Publish call has been made.

Declared In

FMWebSync.h

– removePublished:

Removes a handler that is raised immediately after a Publish call has been made.

- (void)removePublished:(FMCallback *)value

Discussion

Removes a handler that is raised immediately after a Publish call has been made.

Declared In

FMWebSync.h

– setMaxBatchSize:

Sets the maximum number of publications that will be transferred to a server in one HTTP request. A MaxBatchSize of 0 or less will remove the maximum limit, and all queued publications will be sent every time. Defaults to 1000.

- (void)setMaxBatchSize:(int)value

Discussion

Sets the maximum number of publications that will be transferred to a server in one HTTP request. A MaxBatchSize of 0 or less will remove the maximum limit, and all queued publications will be sent every time. Defaults to 1000.

Declared In

FMWebSync.h

– start

Starts the queue’s internal thread.

- (void)start

Discussion

Starts the queue’s internal thread.

Declared In

FMWebSync.h

– stop

Stops the queue’s internal thread.

- (void)stop

Discussion

Stops the queue’s internal thread.

Declared In

FMWebSync.h