Diffusion Apple API
6.10.4
Unified Client Library for iOS, tvOS and OS X / macOS
|
Enumerations | |
enum | PTDiffusionTopicType { PTDiffusionTopicType_Binary = 13, PTDiffusionTopicType_JSON = 14, PTDiffusionTopicType_Double = 15, PTDiffusionTopicType_Int64 = 16, PTDiffusionTopicType_String = 17, PTDiffusionTopicType_TimeSeries = 18, PTDiffusionTopicType_RecordV2 = 19, PTDiffusionTopicType_Unknown = 20 } |
Functions | |
NSString * | PTDiffusionTopicTypeToString (PTDiffusionTopicType topicType) |
NSString * | PTDiffusionTopicTypeToName (PTDiffusionTopicType topicType) |
The topic type determines the type of the data values a topic publishes to subscribers.
Most topics are source topics. The characteristics of each type of source topic are summarized in the following table.
Topic type | State | Data type |
---|---|---|
PTDiffusionTopicType_String | Single scalar value. | String. |
PTDiffusionTopicType_Int64 | Single scalar value. | 64-bit integer. |
PTDiffusionTopicType_Double | Single scalar value. | Double precision floating point number. |
PTDiffusionTopicType_Binary | Single scalar value. | Arbitrary binary data. |
PTDiffusionTopicType_RecordV2 | Single composite value. | PTDiffusionRecordV2 – Diffusion-specific data type. A list of records, each composed of field values, with an optional schema. |
PTDiffusionTopicType_JSON | Single composite value. | PTDiffusionJSON, backed by CBOR-format binary. |
PTDiffusionTopicType_TimeSeries | Append-only log of events. | PTDiffusionTimeSeriesEvent containing a value of a well-known data type. |
enum PTDiffusionTopicType |
Enumerator | |
---|---|
PTDiffusionTopicType_Binary |
Topic that stores and publishes binary values. Based on the PTDiffusionBinary data type. Supports delta-streams.
|
PTDiffusionTopicType_JSON |
Topic that stores and publishes JSON (JavaScript Object Notation) values. Based on the PTDiffusionJSON data type. Supports delta-streams.
|
PTDiffusionTopicType_Double |
Topic that stores and publishes IEEE 754 double-precision floating point numbers. Based on the double data type. Supports The topic does not support delta-streams — only complete values are transmitted.
|
PTDiffusionTopicType_Int64 |
Topic that stores and publishes 64-bit integer values. Based on the int64 data type. Supports The topic does not support delta-streams — only complete values are transmitted.
|
PTDiffusionTopicType_String |
Topic that stores and publishes string values. Based on the string data type. Supports Supports delta-streams.
|
PTDiffusionTopicType_TimeSeries |
A time series is a sequence of events. Each event contains a value and has server-assigned metadata comprised of a sequence number, timestamp, and author. A time series topic allows sessions to access a time series that is maintained by the server. A time series topic has an associated event data type that determines the type of value associated with each event. Retained rangeThe [PTDiffusionTopicSpecification timeSeriesSubscriptionRange] property configures the range of historic events retained by a time series topic. If the property is not specified, a time series topic will retain the ten most recent events. Subscription rangeThe [PTDiffusionTopicSpecification timeSeriesSubscriptionRange] property configures a time series topic to send a range of historic events from the end of the time series to new subscribers. This is a convenient way to synchronize new subscribers without requiring the use of a range query. By default, new subscribers will be sent the latest event if delta streams are enabled and no events if delta streams are disabled. Mandatory propertiesThe [PTDiffusionTopicSpecification timeSeriesEventValueType] property must be provided when creating a time series topic.
|
PTDiffusionTopicType_RecordV2 |
Topic that stores and publishes data in the form of records and fields. Supports delta-streams.
|
PTDiffusionTopicType_Unknown |
A topic type that is unsupported by the session.
|
NSString* PTDiffusionTopicTypeToName | ( | PTDiffusionTopicType | topicType | ) |
Returns the name of this topic type constant, exactly as declared in its enum declaration in the Diffusion API for Java.
topicType | The topic type for which the name is to be returned. |
NSString* PTDiffusionTopicTypeToString | ( | PTDiffusionTopicType | topicType | ) |
Returns a localized string representation of the given topic type.
topicType | The topic type for which a description is to be returned. |