![]() |
DEPRECATED: Diffusion iOS Classic API
5.9.4
|
Common constants, macros and enumerations. More...
Go to the source code of this file.
Data Structures | |
category | NSMutableData(DFCommon) |
category | NSArray(DFCommon) |
Macros | |
#define | DLog(fmt,...) |
Logging macro. | |
#define | WS @"ws" |
The protocols currently supported. | |
#define | DIFFUSION_ERROR_DOMAIN @"Diffusion" |
Error domain key used when populating NSError objects. | |
Variables | |
const char * | transportVersion |
Diffusion version string constant. | |
Common constants, macros and enumerations.
Created by mcowie on 15/10/2010 - Diffusion 5.9.4_01 Copyright © 2009, 2015 Push Technology Ltd. All rights reserved.
#define DLog | ( | fmt, | |
... | |||
) |
Logging macro.
Prints filename, function-name and line number, then the arguments, providing DEBUG is defined.
fmt | printf-style format string |
enum DFNotificationLevel |
Specifies the level of notification that the client wishes to receive.
DNL_MINIMUM |
The minimum level of notification that can be received which will simply notify the topic name and its type. |
DNL_PROPERTIES |
This level of notification is the same as DNL_MINIMUM plus all properties of the Topic. See DFTopicProperty and DFTopicDefinition. |
DNL_METADATA |
This level of notification is the same as DNL_MINIMUM plus any metadata associated with the Topic. |
DNL_FULL |
The level of notification provides all details of the Topic and would be the level needed in order to replicate the Topic. This is equivalent to DNL_MINIMUM plus DNL_PROPERTIES plus DNL_METADATA. |
DNL_NONE |
This special setting may be used to indicate that add notifications are not required. |
enum DFSelectionMode |
Specifies the mode when selecting topic ranges for notification.
enum DFTopicDataType |
Defines the type of an instance of TopicData.
enum DFTopicProperty |
Specifies Topic Property keys that may be used in the DFTopicDefinition properties field.
DTP_ALIASING |
Specifies whether the Topic should use Topic Aliasing. This is an optional Boolean property and if not specified then the aliasing requirement will be taken from the Publisher. |
DTP_ATTACHMENT |
This property defines the topic attachment. This is an optional Object to be attached to the topic. |
DTP_ATTACHMENT_CLASS |
This property defines the a Topic attachment class. This is an optional String property specifying a full class name. If specified then the no arguments constructor of the class will be used to create an instance of the class and attach it to the topic. This property would be ignored if DTP_ATTACHMENT is specified. |
DTP_CUSTOM_HANDLER |
Specifies a Custom Topic Handler. This is used with Topics of type DTP_CUSTOM but would be ignored for all other types. It is an Object property where the object must be of type CustomTopicDataHandler. |
DTP_CUSTOM_HANDLER_CLASS |
Specifies a Custom Topic Handler. This is used with Topics of type DTP_CUSTOM but would be ignored for all other types. This is a String property specifying a loadable class of type CustomTopicDataHandler which must have a no arguments constructor which will be used to create an instance of the handler when the Topic is created. This is ignored if DTP_CUSTOM_HANDLER is specified. To create a Topic of type CUSTOM either this property or CUSTOM_HANDLER must be supplied. |
DTP_DATA_INITIALISER |
Specifies a Topic Data Initialiser. This is used with Topics of type PublishingTopicData but would be ignored for all other types. This is an Object property of type TopicDataInitialiser. This is ignored if DTP_DATA_INITIALISER is specified. |
DTP_DATA_INITIALISER_CLASS |
Specifies a Topic Data Initialiser class. This is used with Topics of type PublishingTopicData but would be ignored for all other types. This is a String property specifying a loadable class of type TopicDataInitialiser which must have a no arguments constructor which will be used to create an instance of the handler when the Topic is created. This is ignored if DTP_DATA_INITIALISER is specified. |
DTP_DELTA_ACK_REQUIRED |
Specifies that delta messages require acknowledgment. This is an optional Boolean property that only applies to Topics that have data of type PublishingTopicData. |
DTP_DELTA_ENCODING |
Delta Encoding. This is an optional Byte value. The value must be one of the DFEncoding values. |
DTP_DELTA_MESSAGE_CAPACITY |
Specifies the default delta message capacity. This is an optional Integer property. |
DTP_DOMAIN_TOPIC_NAME |
Domain Topic Name. This indicates that the Topic is a subdomain of the specified Topic which is a Remote Control Service Topic DTP_REMOTE_SERVICE. This is not a supported property when creating a Topic but will be returned in any DFTopicDefinition returned from such a Topic. |
DTP_INTROSPECTION_MASK |
Introspection mask. This is optional Byte property. |
DTP_LOAD_ACK_REQUIRED |
Specifies that load messages require acknowledgment. This is an optional Boolean property that only applies to Topics that have data of type PublishingTopicData. |
DTP_LOAD_ENCODING |
Load Encoding. This is an optional Byte property. The value must be one of the DFEncoding values. |
DTP_LOAD_HEADERS |
Specifies headers to be associated with load messages. This is an optional String property that only applies to Topics that have data of type PublishingTopicData. |
DTP_LOAD_MESSAGE_CAPACITY |
Specifies the default load message capacity. This is an optional Integer property. |
DTP_LOCKABLE |
Indicates whether the topic is lockable. This is an optional Boolean property. This only applies to a Topic of type TopicDataType.NONE and if not specified then 'YES' would be assumed. |
DTP_LOCK_TIMEOUT |
Lock timeout. This is an optional Long property. |
DTP_NOTIFY_ALL_TOPICS |
Specifies whether a Topic Notify Topic notifies all Topics or only those owned by the same Publisher as the notifier. This is an optional Boolean property which applies only to Topics of type DTP_TOPIC_NOTIFY}. |
DTP_NOTIFY_METADATA_CACHING |
Specifies whether a Topic Notify Topic supports metadata caching. This is an Optional boolean property which applies only to Topics of type DTP_TOPIC_NOTIFY |
DTP_PAGED_COMPARATOR |
Specifies a Paged Topic Comparator. This may optionally be used with Topics of type DTP_PAGED_RECORD or DTP_PAGED_STRING but would be ignored for all other types. It is an Object property where the object must be of type Comparator with a generic type of either Record or String depending on Topic Data type. If a comparator is specified then the Topic Data will be ordered using the comparator. |
DTP_PAGED_COMPARATOR_CLASS |
Specifies a Paged Topic Comparator class. This may optionally be used with Topics of type DTP_PAGED_RECORD or DTP_PAGED_STRING but would be ignored for all other types. This is a String property specifying a loadable class of type Comparator which must have a no arguments constructor which will be used to create an instance of the handler when the Topic is created. The comparator should have a generic type of either Record or String depending on Topic Data type. This is ignored if DTP_PAGED_COMPARATOR is specified. If a comparator is specified then the Topic Data will be ordered using the comparator. |
DTP_PAGED_DUPLICATES_POLICY |
Specifies Paged Topic Data Duplicates Policy. This is an optional property that only has meaning for Topics that have data of type DTP_PAGED_RECORD or DTP_PAGED_STRING. It is ignored for all other types. It is a String property that may be one of the update mode code values as obtained from Duplicates.getCode(). If not specified then Duplicates.NOT_ALLOWED is assumed. |
DTP_PB_CLASS |
Specifies a Protocol Buffer proto class name. This is a String property that that is mandatory for Topics that have data of type DTDT_PROTOCOL_BUFFER. It is ignored for all other types. |
DTP_PB_DELETION_VALUE |
Specifies the Protocol Buffers Topic Data Deletion Value. This is an optional property that only has meaning for Topics that have data of type DTDT_PROTOCOL_BUFFER. It is ignored for all other types. It is a String property that specifies a value used to represent field deletions. If not specified then PBTopicData.DEFAULT_DELETION_VALUE is assumed. |
DTP_PB_NAME |
Specifies a Protocol Buffers Message name. This is a String property that is mandatory for Topics that have data of type DTDT_PROTOCOL_BUFFER. It is ignored for all other types. |
DTP_PB_UPDATE_MODE |
Specifies the Protocol Buffers Topic Data Update Mode. This is an optional property that only has meaning for Topics that have data of type DTDT_PROTOCOL_BUFFER. It is ignored for all other types. It is a String property that may be one of the update mode code values as obtained from UpdateMode.getCode(). If not specified then UpdateMode.PARTIAL is assumed. See PBTopicData.setUpdateMode(UpdateMode) for more details. |
DTP_RECORD_EMPTY_FIELD_VALUE |
Specifies a value to use to represent empty fields. This is an optional String property for use with Topics of type DTDT_RECORD and would be ignored for all other types. See RecordTopicData.setEmptyFieldValue(String) for details. |
DTP_REFERENCE |
This specifies the Topic reference. This is an optional String property. |
DTP_ROUTING_HANDLER |
Specifies a Routing Topic Subscription Handler. This is an Object property used with Topics of type DTDT_ROUTING and would be ignored for all other types. The object specified must be of type RoutingTopicDataSubscriptionHandler. To create a Topic of type opicDataType.ROUTING either this property or DTP_ROUTING_HANDLER must be supplied. |
DTP_ROUTING_HANDLER_CLASS |
Specifies a Routing Topic Subscription Handler. This is a String property used with Topics of type DTDT_ROUTING and would be ignored for all other types. It specifies a loadable class of type RoutingTopicDataSubscriptionHandler which must have a no arguments constructor which that be used to create an instance of the handler to attach to the Topic. This will be ignored if DTP_ROUTING_HANDLER is specified. To create a Topic of type DTDT_ROUTING either this property or DTP_ROUTING_HANDLER must be supplied. |
DTP_SERVICE_HANDLER |
Specifies a Service handler. This is an Object property which only applies to Topics of type DTDT_SERVICE and would be ignored for all other types. The object specified must be of type ServiceHandler. To create a Topic of type DTDT_SERVICE either this property or DTP_SERVICE_HANDLER must be supplied. |
DTP_SERVICE_HANDLER_CLASS |
Specifies a Service handler. This is a String property which only applies to Topics of type DTDT_SERVICE and would be ignored for all other types. It specifies a loadable class of type ServiceHandler which must have a no arguments constructor which will be used to create an instance of the handler to attach to the Topic. This is ignored is DTP_SERVICE_HANDLER is specified. To create a Topic of type TopicDataType.SERVICE either this property or DTP_SERVICE_HANDLER must be supplied. |
DTP_SERVICE_HEADERS |
Specifies service header options. This is an optional String property that only applies for Topics of type DTDT_SERVICE and would be ignored for all other types. |
DTP_SERVICE_TARGET_TOPIC |
Specifies a service target topic name. This is an optional String property that only applies to Topics of type DTDT_SERVICE and would be ignored for all other types. |
DTP_SERVICE_TIMEOUT |
Specifies a service request timeout. This is an optional Long property only applies for Topics of type DTDT_SERVICE and would be ignored for all other types. |
DTP_SERVICE_TYPE |
Specifies Service Type. This is a mandatory String property for Topics of type DTDT_SERVICE and is ignored for all other types. |
DTP_SLAVE_MASTER_TOPIC |
Specifies the master Topic name for a Slave Topic. This is a mandatory String property for topics of type DTDT_SLAVE and will be ignored for all other types. |
DTP_SUBSCRIPTION_HANDLER |
Specifies a Subscription Handler. This is an optional String property specifying the full name of a loadable class of type TopicSubscriptionHandler. If specified then the class must have a no arguments constructor which will be used to create and associate the handler object when the topic is created. This is ignored if DTP_SUBSCRIPTION_HANDLER is specified. |
DTP_SUBSCRIPTION_HANDLER_CLASS |
Specifies a Subscription Handler. This is an optional String property specifying the full name of a loadable class of type TopicSubscriptionHandler. If specified then the class must have a no arguments constructor which will be used to create and associate the handler object when the topic is created. This is ignored if DTP_SUBSCRIPTION_HANDLER is specified. |
DTP_TIDY_ON_UNSUBSCRIBE |
Tidy on Unsubscribe. This is optional Boolean property. |