Include global constants and typedefs. More...

Functions
typedef	NS_ENUM (NSInteger, LogType)
	This class enumerates the MigratoryData logging levels. More...

Variables
NSString *	NOTIFY_SERVER_UP
	Indicate that the client successfully connected to a MigratoryData server. More...

NSString *	NOTIFY_SERVER_DOWN
	Indicate that the client failed to connect to a MigratoryData server. More...

NSString *	NOTIFY_DATA_SYNC
	After a failover reconnection, the client synchronized a subscribed subject with the latest message available for that subject, as well as with all messages published during the failover for that subject. More...

NSString *	NOTIFY_DATA_RESYNC
	After a failover reconnection, the client synchronized a subscribed subject with the latest message available for that subject, but not with the potential messages published during the failover, therefore behaving as a new client. More...

NSString *	NOTIFY_SUBSCRIBE_ALLOW
	Indicate that the client was authorized to subscribe to a subject. More...

NSString *	NOTIFY_SUBSCRIBE_DENY
	Indicate that the client was not authorized to subscribe to a subject. More...

NSString *	NOTIFY_PUBLISH_DENIED
	Indicate that the client was unable to publish a message because it is not allowed by your entitlement rules. More...

NSString *	NOTIFY_SUBSCRIBE_TIMEOUT

NSString *	NOTIFY_PUBLISH_NO_SUBSCRIBER
	Indicate that the client was unable to publish a message because there is no client subscribed to the subject of the message. More...

NSString *	NOTIFY_PUBLISH_OK
	Indicate that the client successfully published a message. More...

NSString *	NOTIFY_PUBLISH_FAILED
	Indicate that the client was unable to publish a message. More...

NSString *	CONSTANT_WINDOW_BACKOFF
	A constant used to define the reconnect policy. More...

NSString *	TRUNCATED_EXPONENTIAL_BACKOFF
	A constant used to define the reconnect policy. More...

Detailed Description

Include global constants and typedefs.

Function Documentation

◆ NS_ENUM()

typedef NS_ENUM	(	NSInteger	,
		LogType
	)

This class enumerates the MigratoryData logging levels.

The available logging levels ordered by verbosity are:

LOG_ERROR (less verbose)
LOG_INFO
LOG_DEBUG
LOG_TRACE (most verbose)

For production usage, we recommend the default LOG_INFO logging level.

The LOG_ERROR level turns on the error logs of the API.

The LOG_INFO level turns on the info, warning, and error logs of the API.

The LOG_DEBUG level turns on the debug, info, warning, and error logs of the API.

The LOG_TRACE level turns on all the logs of the API.

Variable Documentation

◆ NOTIFY_SERVER_UP

NSString* NOTIFY_SERVER_UP

Indicate that the client successfully connected to a MigratoryData server.

This constant indicates that the client successfully connected to one of the MigratoryData servers defined with the API method MigratoryDataClient::setServers:.

◆ NOTIFY_SERVER_DOWN

NSString* NOTIFY_SERVER_DOWN

Indicate that the client failed to connect to a MigratoryData server.

This constant indicates that the client failed to connect to one of the MigratoryData servers defined with the API method MigratoryDataClient::setServers:.

◆ NOTIFY_DATA_SYNC

NSString* NOTIFY_DATA_SYNC

After a failover reconnection, the client synchronized a subscribed subject with the latest message available for that subject, as well as with all messages published during the failover for that subject.

This constant indicates that the client successfully synchronized the subject provided in the detail information of the status notification. Also, the potential messages published for that subject during the failover period have been successfully retrieved at the moment of the reconnection.

◆ NOTIFY_DATA_RESYNC

NSString* NOTIFY_DATA_RESYNC

After a failover reconnection, the client synchronized a subscribed subject with the latest message available for that subject, but not with the potential messages published during the failover, therefore behaving as a new client.

This constant indicates that the client successfully synchronized the subject provided in the detail information of the status notification. However, the client was unable to get the messages published during the failover. Therefore, it behaves like a new client which connects to the MigratoryData server at the moment of the failover reconnection.

◆ NOTIFY_SUBSCRIBE_ALLOW

NSString* NOTIFY_SUBSCRIBE_ALLOW

Indicate that the client was authorized to subscribe to a subject.

This constant indicates that the client – identified with the token defined with the API method MigratoryDataClient::setEntitlementToken: – is allowed to subscribe to the subject provided in the detail information of the status notification.

◆ NOTIFY_SUBSCRIBE_DENY

NSString* NOTIFY_SUBSCRIBE_DENY

Indicate that the client was not authorized to subscribe to a subject.

This constant indicates that the client – identified with the token defined with the API method MigratoryDataClient::setEntitlementToken: – is not allowed to subscribe to the subject provided in the detail information of the status notification.

◆ NOTIFY_PUBLISH_DENIED

NSString* NOTIFY_PUBLISH_DENIED

Indicate that the client was unable to publish a message because it is not allowed by your entitlement rules.

This constant is used to indicate that the publication of the message, having the closure provided in the detail information of the status notification, has failed. The publication failed because the client – identified with the token defined with the API method MigratoryDataClient::setEntitlementToken: – is not allowed to publish on the subject of the message.

◆ NOTIFY_PUBLISH_NO_SUBSCRIBER

NSString* NOTIFY_PUBLISH_NO_SUBSCRIBER

Indicate that the client was unable to publish a message because there is no client subscribed to the subject of the message.

This constant is used to indicate that the publication of the message, having the closure provided in the detail information of the status notification, has failed. The publication failed because there is no client then subscribed to the subject of the message.

Deprecated:: no more is use.

◆ NOTIFY_PUBLISH_OK

NSString* NOTIFY_PUBLISH_OK

Indicate that the client successfully published a message.

This constant is used to indicate that the publication of the message, having the closure provided in the detail information of the status notification, has succeeded.

◆ NOTIFY_PUBLISH_FAILED

NSString* NOTIFY_PUBLISH_FAILED

Indicate that the client was unable to publish a message.

This constant is used to indicate that the publication of the message, having the closure provided in the detail information of the status notification, has failed.

◆ CONSTANT_WINDOW_BACKOFF

NSString* CONSTANT_WINDOW_BACKOFF

A constant used to define the reconnect policy.

See MigratoryDataClient::setQuickReconnectInitialDelay() for more details about this policy.

◆ TRUNCATED_EXPONENTIAL_BACKOFF

NSString* TRUNCATED_EXPONENTIAL_BACKOFF