Diffusion Apple API  6.1.5
Unified Client Library for iOS, tvOS and OS X / macOS
 All Classes Functions Variables Properties Pages
Contents
Diffusion Unified client library interfaces and protocols:
oCPTDiffusionAddTopicResultThe result of adding a topic
oCPTDiffusionBasicHTTPProxyAuthenticationProvider of responses to basic authentication challenges from HTTP proxies
oCPTDiffusionBinaryAn immutable binary value with support for binary deltas
oCPTDiffusionBinaryDeltaAn immutable delta describing the differences between two binary values
oC<PTDiffusionBinaryRequestDelegate>Methods implemented by classes handling Binary messaging requests with a handler registered at the server
oC<PTDiffusionBinaryRequestStreamDelegate>Methods implemented by classes handling Binary messaging requests
oC<PTDiffusionBinarySessionResponseStreamDelegate>Methods implemented by classes handling Binary messaging responses from individual sessions
oCPTDiffusionBinaryTimeSeriesEventAn event in a time series whose value may be interpreted as Binary
oC<PTDiffusionBinaryTimeSeriesEventValueStreamDelegate>Methods implemented by classes handling streamed time series events with binary values
oCPTDiffusionBinaryTimeSeriesQueryResultQuery result providing an array of binary time series events
oC<PTDiffusionBinaryValueStreamDelegate>Methods implemented by classes handling streamed events for binary value topics
oCPTDiffusionBinaryValueUpdaterA binary value updater may be used to update binary topics by specifying new values
oCPTDiffusionBytesA value that is internally represented as binary data
oCPTDiffusionContentContent can represent the state of a topic
oCPTDiffusionCredentialsCredentials contain the proof material to support an authentication request
oC<PTDiffusionDataType>Methods implemented by classes providing data type implementations
oCPTDiffusionDataTypesDiffusion data type implementations
oCPTDiffusionDefaultSessionResponseStreamDelegateDefault delegate implementation which may be used as an abstract base for sub-protocol implementations
oCPTDiffusionDefaultStreamDelegateDefault delegate implementation which may be used as an abstract base for sub-protocol implementations
oCPTDiffusionDefaultSubscriberStreamDelegateDefault delegate implementation which may be used as an abstract base for sub-protocol implementations
oCPTDiffusionDefaultTopicNotificationListenerDefault delegate implementation which may be used as an abstract base for sub-protocol implementations
oCPTDiffusionDefaultTopicTreeRegistrationDelegateDefault delegate implementation which may be used as an abstract base for sub-protocol implementations
oCPTDiffusionEnumerationBase class for objects offering a selection of predefined constant values
oC<PTDiffusionErrorListener>Methods implemented by classes wishing to listen to error notifications
oCPTDiffusionFeatureA feature is a unit of functionality that is available to a client session
oC<PTDiffusionFetchStreamDelegate>The fetch stream delegate protocol defines the methods to be implemented by classes wishing to receive responses to topic fetch requests
oCPTDiffusionFieldA field represents a single value in a record
oCPTDiffusionFieldMetadataField metadata describes a data item that can have a value
oC<PTDiffusionHTTPAuthentication>The protocol implemented by classes providing authentication challenge handler implementations for HTTP connections
oCPTDiffusionHTTPAuthenticationChallengeAn HTTP response from a server connection request, challenging the client to authenticate
oC<PTDiffusionHTTPAuthenticationChallengeHandler>The protocol implemented by classes providing an authentication challenge handler implementation for HTTP connections
oCPTDiffusionHTTPAuthenticationChallengeStatusAn HTTP Status received as part of an authentication challenge
oCPTDiffusionHTTPProxyConfigurationConnection details for an HTTP proxy to be tunneled through in order to reach the Diffusion server
oCPTDiffusionJSONAn immutable JSON value with support for both binary and JSON deltas
oC<PTDiffusionJSONRequestDelegate>Methods implemented by classes handling JSON messaging requests with a handler registered at the server
oC<PTDiffusionJSONRequestStreamDelegate>Methods implemented by classes handling JSON messaging requests
oC<PTDiffusionJSONSessionResponseStreamDelegate>Methods implemented by classes handling JSON messaging responses from individual sessions
oCPTDiffusionJSONTimeSeriesEventAn event in a time series whose value may be interpreted as JSON
oC<PTDiffusionJSONTimeSeriesEventValueStreamDelegate>Methods implemented by classes handling streamed time series events with JSON values
oCPTDiffusionJSONTimeSeriesQueryResultQuery result providing an array of JSON time series events
oC<PTDiffusionJSONValueStreamDelegate>Methods implemented by classes handling streamed events for JSON value topics
oCPTDiffusionJSONValueUpdaterA JSON value updater may be used to update JSON topics by specifying new values
oCPTDiffusionLoggingLogging provides access to debug information that can be enabled at runtime
oCPTDiffusionLoggingDestinationConfigurationOptions allowing log output to be directed to a custom location
oCPTDiffusionLoggingLevelA level of information events useful for debugging
oC<PTDiffusionMessageDelegate>Handler for receiving messages from clients, with associated content and optional information
oCPTDiffusionMessageStreamA message stream represents an asynchronous, variable length feed of message events from the Diffusion server
oC<PTDiffusionMessageStreamDelegate>The message stream delegate protocol defines the methods to be implemented by classes wishing to receive messages
oCPTDiffusionMessagingControlFeatureThe Messaging Control feature provides a client session with the ability to use messaging functionality to communicate directly with other client sessions
oCPTDiffusionMessagingControlFeature(PTDiffusionBinary)Extension adding support to the Messaging Control feature for sending requests accepting a binary response
oCPTDiffusionMessagingControlFeature(PTDiffusionJSON)Extension adding support to the Messaging Control feature for sending requests accepting a JSON response
oCPTDiffusionMessagingControlFeature(PTDiffusionPrimitive)Extension adding support to the Messaging Control feature for sending requests accepting a primitive value in response
oCPTDiffusionMessagingControlFeature(PTDiffusionRecordV2)Extension adding support to the Messaging Control feature for sending requests accepting a record response
oCPTDiffusionMessagingFeatureThe Messaging feature provides a client session with messaging capabilities
oCPTDiffusionMessagingFeature(PTDiffusionBinary)Extension adding support to the Messaging feature for sending requests accepting a binary response
oCPTDiffusionMessagingFeature(PTDiffusionJSON)Extension adding support to the Messaging feature for sending requests accepting a JSON response
oCPTDiffusionMessagingFeature(PTDiffusionPrimitive)Extension adding support to the Messaging feature for sending requests accepting a primitive value in response
oCPTDiffusionMessagingFeature(PTDiffusionRecordV2)Extension adding support to the Messaging feature for sending requests accepting a record response
oCPTDiffusionMetadataMetadata is the base interface for both record and field metadata definition nodes
oC<PTDiffusionMissingTopicHandler>Handler called when a client session subscribes or fetches using a topic selector that matches no topics
oCPTDiffusionMissingTopicNotificationNotification that a session has made a request using a selector that does not match any topics
oCPTDiffusionMultiplicityMultiplicity describes the number of times that a metadata node may occur within its parent
oCPTDiffusionMutableRecordV2ModelA mutable data model based upon a schema
oCPTDiffusionMutableSendOptionsMutable send options can be modified prior to being associated with sending content
oCPTDiffusionMutableSessionConfigurationA mutable session configuration can be modified prior to being used to define behaviour and policies to use when connecting to Diffusion
oCPTDiffusionNumberFieldMetadataNumber field metadata describes a data item that can have a numerical value
oC<PTDiffusionNumberRequestDelegate>Methods implemented by classes handling numeric messaging requests with a handler registered at the server
oC<PTDiffusionNumberRequestStreamDelegate>Methods implemented by classes handling JSON messaging requests
oC<PTDiffusionNumberSessionResponseStreamDelegate>Methods implemented by classes handling numeric messaging responses from individual sessions
oCPTDiffusionNumberTimeSeriesEventAn event in a time series whose value may be interpreted as a number
oC<PTDiffusionNumberTimeSeriesEventValueStreamDelegate>Methods implemented by classes handling streamed time series events with numeric values
oCPTDiffusionNumberTimeSeriesQueryResultQuery result providing an array of number time series events
oC<PTDiffusionNumberValueStreamDelegate>Methods implemented by classes handling streamed events for number value topics
oCPTDiffusionNumberValueUpdaterA number value updater may be used to update numeric topics by specifying new values as NSNumber objects
oCPTDiffusionPingDetailsDetails returned in response to a ping to the server
oCPTDiffusionPingsFeatureThe Pings feature provides a client session with the ability to ping the server
oCPTDiffusionPrimitiveSupport for creating value streams for primitive values including string and numeric types
oCPTDiffusionReceiveContextA receive context provides additional contextual information for received content
oCPTDiffusionRecordA record is a collection of fields
oCPTDiffusionRecordContentRecord content is a collection of records
oCPTDiffusionRecordContentSchemaA record content schema describes a data item that can represent a collection of records
oCPTDiffusionRecordMetadataRecord metadata describes a data item that can represent a collection of fields
oCPTDiffusionRecordTopicAttributesAttributes specific to record topics
oC<PTDiffusionRecordTopicDetailsBuilder>The protocol to which record topic details builders conform
oCPTDiffusionRecordTopicSchemaSchema for record topics
oCPTDiffusionRecordV2An immutable record value with support for binary deltas
oCPTDiffusionRecordV2BuilderBuilds free format PTDiffusionRecordV2 values
oCPTDiffusionRecordV2DeltaA description of the differences between two record values
oCPTDiffusionRecordV2DeltaChangeRepresents a single change between one record value and another
oCPTDiffusionRecordV2DeltaChangeTypeThe type of change represented by a record delta
oCPTDiffusionRecordV2ModelA data model based upon a schema
oC<PTDiffusionRecordV2RequestDelegate>Methods implemented by classes handling record messaging requests with a handler registered at the server
oC<PTDiffusionRecordV2RequestStreamDelegate>Methods implemented by classes handling record messaging requests
oCPTDiffusionRecordV2SchemaA schema
oCPTDiffusionRecordV2SchemaBuilderUsed to build an immutable PTDiffusionRecordV2Schema
oCPTDiffusionRecordV2SchemaFieldA field definition within a schema
oCPTDiffusionRecordV2SchemaFieldTypeType of field defined within a schema
oCPTDiffusionRecordV2SchemaNodeA node within a schema
oCPTDiffusionRecordV2SchemaRecordA record definition within a schema
oC<PTDiffusionRecordV2SessionResponseStreamDelegate>Methods implemented by classes handling record messaging responses from individual sessions
oCPTDiffusionRecordV2TimeSeriesEventAn event in a time series whose value may be interpreted as a record
oC<PTDiffusionRecordV2TimeSeriesEventValueStreamDelegate>Methods implemented by classes handling streamed time series events with record values
oCPTDiffusionRecordV2TimeSeriesQueryResultQuery result providing an array of record time series events
oC<PTDiffusionRecordV2ValueStreamDelegate>Methods implemented by classes handling streamed events for record value topics
oCPTDiffusionRecordV2ValueUpdaterA record value updater may be used to update record topics by specifying new values
oCPTDiffusionRegistrationA reference to a registered handle
oCPTDiffusionRequestA request to be sent using messaging
oCPTDiffusionRequestContextA request context provides additional contextual information for received messaging requests
oCPTDiffusionRequestHandlerHandler to receive request notifications
oCPTDiffusionRequestStreamA request stream represents an asynchronous, variable length feed of messaging requests
oCPTDiffusionResponderResponder provided with requests, used to dispatch responses
oCPTDiffusionResponder(PTDiffusionBinary)Extension adding support for responding to requests using Binary values
oCPTDiffusionResponder(PTDiffusionJSON)Extension adding support for responding to requests using JSON values
oCPTDiffusionResponder(PTDiffusionPrimitive)Extension adding support for responding to requests using primitive values
oCPTDiffusionResponder(PTDiffusionRecordV2)Extension adding support for responding to requests using record values
oCPTDiffusionResponseA response to be sent using messaging
oCPTDiffusionRoutingTopicAttributesAttributes specific to routing topics
oC<PTDiffusionRoutingTopicDetailsBuilder>The protocol to which routing topic details builders conform
oCPTDiffusionSecurityFeatureThe Security feature provides a client session with the ability to change the associated principal
oCPTDiffusionSendOptionsSend options are associated with sending content
oCPTDiffusionSessionA session represents a single connection to a single Diffusion server
oCPTDiffusionSessionConfigurationA session configuration defines behavior and policies to use when connecting to Diffusion
oCPTDiffusionSessionDelayedReconnectionStrategyDelayed is a default reconnection strategy supplied with the client library
oCPTDiffusionSessionIdA session ID is a unique session identifier, allocated by the server
oCPTDiffusionSessionImmediateAbortReconnectionStrategyImmediate abort is a default reconnection strategy supplied with the client library
oCPTDiffusionSessionReconnectionAttemptA session reconnection attempt can either be started or aborted
oC<PTDiffusionSessionReconnectionStrategy>The session reconnection strategy protocol defines the behaviour for a session when recovering a failed connection
oCPTDiffusionSessionResponseStreamA response stream represents an asynchronous, variable length feed of messaging responses from other sessions
oC<PTDiffusionSessionResponseStreamDelegate>Methods implemented by classes handling messaging responses from individual sessions
oCPTDiffusionSessionStateSession state represents the condition a session has in respect of connectivity to a Diffusion server
oCPTDiffusionSessionStateChangeA session state change represents a change in a session's state
oC<PTDiffusionSingleValueTopicDetailsBuilder>The protocol to which single value topic details builders conform
oCPTDiffusionSingleValueTopicSchemaSchema for single value topics
oCPTDiffusionSlaveTopicAttributesAttributes specific to slave topics
oC<PTDiffusionSlaveTopicDetailsBuilder>The protocol to which slave topic details builders conform
oCPTDiffusionStreamA stream represents an asynchronous, variable length feed of updates from the Diffusion server
oC<PTDiffusionStreamDelegate>The stream delegate protocol defines the methods to be implemented by classes wishing to receive streaming updates
oCPTDiffusionStringFieldMetadataString field metadata describes a data item that can have a textual value
oC<PTDiffusionStringRequestDelegate>Methods implemented by classes handling string messaging requests with a handler registered at the server
oC<PTDiffusionStringRequestStreamDelegate>Methods implemented by classes handling JSON messaging requests
oC<PTDiffusionStringSessionResponseStreamDelegate>Methods implemented by classes handling string messaging responses from individual sessions
oCPTDiffusionStringTimeSeriesEventAn event in a time series whose value may be interpreted as a string
oC<PTDiffusionStringTimeSeriesEventValueStreamDelegate>Methods implemented by classes handling streamed time series events with string values
oCPTDiffusionStringTimeSeriesQueryResultQuery result providing an array of string time series events
oC<PTDiffusionStringValueStreamDelegate>Methods implemented by classes handling streamed events for string value topics
oCPTDiffusionStringValueUpdaterA string value updater may be used to update string topics by specifying new values
oC<PTDiffusionSubscriberStreamDelegate>Methods implemented by classes handling streamed subscription events for value topics
oCPTDiffusionSubscriptionControlFeatureThe Subscription Control feature allows a client session to subscribe or unsubscribe other sessions to topics, as well as also providing a mechanism for handling requests to subscribe to routing topics
oCPTDiffusionSubscriptionRoutingRequestA single request from a session to subscribe to a routing topic
oC<PTDiffusionSubscriptionRoutingRequestHandler>Methods implemented by classes handling streamed subscription routing requests
oCPTDiffusionTimeSeriesEventAn event in a time series
oCPTDiffusionTimeSeriesEventMetadataMetadata associated with a time series event
oCPTDiffusionTimeSeriesFeatureThe Time Series feature provides a client session with the ability to update and query time series topics
oCPTDiffusionTimeSeriesFeature(PTDiffusionBinary)Extension adding support to the Time Series feature for appending and editing events using binary values
oCPTDiffusionTimeSeriesFeature(PTDiffusionJSON)Extension adding support to the Time Series feature for appending and editing events using JSON values
oCPTDiffusionTimeSeriesFeature(PTDiffusionPrimitive)Extension adding support to the Time Series feature for appending and editing events using primitive values
oCPTDiffusionTimeSeriesFeature(PTDiffusionRecordV2)Extension adding support to the Time Series feature for appending and editing events using record values
oCPTDiffusionTimeSeriesQueryResultQuery result providing an array of time series events
oCPTDiffusionTimeSeriesQueryResultEventArrayStructureDescribes the structural properties of the array of events presented by a time series query result
oCPTDiffusionTimeSeriesRangeQueryBuilder for queries that select a range of events from a time series
oCPTDiffusionTopicAddFailReasonThe reason for failure to add a Topic
oCPTDiffusionTopicAttributesAttributes applicable to all topic types
oCPTDiffusionTopicControlFeatureThe Topic Control feature provides a client session with the ability to manage topics
oCPTDiffusionTopicDetailsTopic details describe a topic
oC<PTDiffusionTopicDetailsBuilder>All topic details builders conform to this protocol
oCPTDiffusionTopicDetailsLevelThe level of detail to request when getting topic details
oC<PTDiffusionTopicEventListener>Listener for topic events from the server
oC<PTDiffusionTopicNotificationListener>Methods implemented by classes handling streamed topic notifications
oCPTDiffusionTopicNotificationRegistrationThe registration state of the associated topic notification listener on the server
oCPTDiffusionTopicNotificationsFeatureThe Topic Notifications feature allows a client session to receive notifications about changes to selected topics
oCPTDiffusionTopicNotificationTypeThe type of topic notification received
oCPTDiffusionTopicSchemaBase class which has no specific information associated with it
oCPTDiffusionTopicSelectorA topic selector identifies one or more topics
oCPTDiffusionTopicsFeatureThe Topics feature provides a client session with the capability to receive streamed topic updates and/or fetch the state of topics
oCPTDiffusionTopicSpecificationThe specification of a topic
oCPTDiffusionTopicStreamA topic stream represents an asynchronous, variable length feed of subscription, value and delta events from the Diffusion server
oC<PTDiffusionTopicStreamDelegate>The topic stream delegate protocol defines the methods to be implemented by classes wishing to receive streamed topic updates
oCPTDiffusionTopicTreeRegistrationA reference to a handler registered for a particular topic path
oC<PTDiffusionTopicTreeRegistrationDelegate>Common protocol for delegates that establish a server side control presence for the client session at a particular branch of the topic tree
oCPTDiffusionTopicUpdateControlFeatureThe topic update control feature provides a client session with the capability to update topics at the server
oCPTDiffusionTopicUpdaterA topic updater provides methods for an update source to update topics
oCPTDiffusionTopicUpdater(PTDiffusionBinaryValueUpdater)Extension adding support for updating topics using Binary values
oCPTDiffusionTopicUpdater(PTDiffusionJSONValueUpdater)Extension adding support for updating topics using JSON values
oCPTDiffusionTopicUpdater(PTDiffusionNumberValueUpdater)Extension adding support for updating topics using numeric values
oCPTDiffusionTopicUpdater(PTDiffusionRecordV2ValueUpdater)Extension adding support for updating topics using record values
oCPTDiffusionTopicUpdater(PTDiffusionStringValueUpdater)Extension adding support for updating topics using string values
oC<PTDiffusionTopicUpdateSource>A source of updates which may be registered in order to update parts of the topic tree
oCPTDiffusionUpdateContextAn update context provides additional detail associated with an update delivering PTDiffusionContent
oCPTDiffusionValueStreamA value stream represents an asynchronous, variable length feed of subscription and value updates from the Diffusion server
oCPTDiffusionValueUpdaterA value updater may be used to update topics of a certain type by specifying new values
\CPTDiffusionVersionA version represents a released build of the client library