Diffusion Apple API 6.12.1
Unified Client Library for iOS, tvOS and OS X / macOS
Loading...
Searching...
No Matches
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
 CPTDiffusionAddTopicResultThe result of adding a topic
 CPTDiffusionBasicHTTPProxyAuthenticationProvider of responses to basic authentication challenges from HTTP proxies
 CPTDiffusionBinaryAn immutable binary value with support for binary deltas
 CPTDiffusionBinaryDeltaAn immutable delta describing the differences between two binary values
 CPTDiffusionBinaryFetchResultEncapsulates the results from a binary fetch operation issued to the server
 CPTDiffusionBinaryFetchTopicResultEncapsulates the result from a binary fetch operation for a single selected topic
 C<PTDiffusionBinaryRequestDelegate>Methods implemented by classes handling Binary messaging requests with a handler registered at the server
 C<PTDiffusionBinaryRequestStreamDelegate>Methods implemented by classes handling Binary messaging requests
 C<PTDiffusionBinarySessionResponseStreamDelegate>Methods implemented by classes handling Binary messaging responses from individual sessions
 CPTDiffusionBinaryTimeSeriesEventAn event in a time series whose value may be interpreted as Binary
 C<PTDiffusionBinaryTimeSeriesEventValueStreamDelegate>Methods implemented by classes handling streamed time series events with binary values
 CPTDiffusionBinaryTimeSeriesQueryResultQuery result providing an array of binary time series events
 CPTDiffusionBinaryUpdateStreamAn update stream that provides the ability for updating topics with binary values
 C<PTDiffusionBinaryValueStreamDelegate>Methods implemented by classes handling streamed events for binary value topics
 CPTDiffusionBranchMappingA session tree branch mapping
 CPTDiffusionBranchMappingTableA session tree branch mapping table
 CPTDiffusionBranchMappingTableBuilderBuilder for PTDiffusionBranchMappingTable instances
 CPTDiffusionBytesA value that is internally represented as binary data
 C<PTDiffusionCancellable>A cancellable handle to an asynchronous operation
 CPTDiffusionCheckRemoteServerResultInterface for the result of checking the state of a remote server
 CPTDiffusionClientControlFeatureThe Client Control feature provides the ability for a client session to control other client sessions
 C<PTDiffusionClientQueueEventListener>Listener for client message queue events from the server
 CPTDiffusionClientQueuePolicyPolicy for managing a client message queue
 CPTDiffusionCloseReasonSpecifies the reason why a session has been closed
 CPTDiffusionCreateRemoteServerResultInterface for the result from the creation of a remote server
 CPTDiffusionCredentialsCredentials contain the proof material to support an authentication request
 C<PTDiffusionDataType>Methods implemented by classes providing data type implementations
 CPTDiffusionDataTypesDiffusion data type implementations
 CPTDiffusionDefaultSessionResponseStreamDelegateDefault delegate implementation which may be used as an abstract base for sub-protocol implementations
 CPTDiffusionDefaultStreamDelegateDefault delegate implementation which may be used as an abstract base for sub-protocol implementations
 CPTDiffusionDefaultSubscriberStreamDelegateDefault delegate implementation which may be used as an abstract base for sub-protocol implementations
 CPTDiffusionDefaultTopicNotificationListenerDefault delegate implementation which may be used as an abstract base for sub-protocol implementations
 CPTDiffusionDefaultTopicTreeRegistrationDelegateDefault delegate implementation which may be used as an abstract base for sub-protocol implementations
 CPTDiffusionEnumerationBase class for objects offering a selection of predefined constant values
 C<PTDiffusionErrorListener>Methods implemented by classes wishing to listen to error notifications
 CPTDiffusionFeatureA feature is a unit of functionality that is available to a client session
 CPTDiffusionFetchRequestA parameterised query that can be used to search the topic tree
 CPTDiffusionFetchRequest(PTDiffusionBinary)Extension adding support to Topics feature fetch requests allowing them to be constrained to only those topics with a data type compatible with Binary
 CPTDiffusionFetchRequest(PTDiffusionJSON)Extension adding support to Topics feature fetch requests allowing them to be constrained to only those topics with a data type compatible with JSON
 CPTDiffusionFetchRequest(PTDiffusionPrimitive)Extension adding support to Topics feature fetch requests allowing them to be constrained to only those topics with a data type compatible with primitive values
 CPTDiffusionFetchRequest(PTDiffusionRecordV2)Extension adding support to Topics feature fetch requests allowing them to be constrained to only those topics with a data type compatible with records
 CPTDiffusionFetchRequest(PTDiffusionTimeSeriesEvent)Extension adding support to Topics feature fetch requests allowing them to be constrained to only those topics with a data type compatible with time series events
 CPTDiffusionFetchResultBase class for results from fetch operations issued to the server
 CPTDiffusionFetchTopicResultEncapsulates the result from a fetch operation for a single selected topic
 CPTDiffusionGetSessionPropertiesResultEncapsulates the result of a querying the server for the session properties of a particular session ID or session filter
 CPTDiffusionGlobalPermissionPermissions that protect globally scoped, access-controlled operations
 C<PTDiffusionHTTPAuthentication>The protocol implemented by classes providing authentication challenge handler implementations for HTTP connections
 CPTDiffusionHTTPAuthenticationChallengeAn HTTP response from a server connection request, challenging the client to authenticate
 C<PTDiffusionHTTPAuthenticationChallengeHandler>The protocol implemented by classes providing an authentication challenge handler implementation for HTTP connections
 CPTDiffusionHTTPAuthenticationChallengeStatusAn HTTP Status received as part of an authentication challenge
 CPTDiffusionHTTPProxyConfigurationConnection details for an HTTP proxy to be tunneled through in order to reach the Diffusion server
 CPTDiffusionHTTPResponse
 CPTDiffusionJSONAn immutable JSON value with support for both binary and JSON deltas
 CPTDiffusionJSONDeltaAn immutable structural delta describing the differences between two JSON values
 CPTDiffusionJSONDeltaChangeMapAn immutable map describing the changes to a JSON value
 CPTDiffusionJSONFetchResultEncapsulates the results from a JSON fetch operation issued to the server
 CPTDiffusionJSONFetchTopicResultEncapsulates the result from a JSON fetch operation for a single selected topic
 CPTDiffusionJSONPatchResultResult of calls to the Partial Update feature
 C<PTDiffusionJSONRequestDelegate>Methods implemented by classes handling JSON messaging requests with a handler registered at the server
 C<PTDiffusionJSONRequestStreamDelegate>Methods implemented by classes handling JSON messaging requests
 C<PTDiffusionJSONSessionResponseStreamDelegate>Methods implemented by classes handling JSON messaging responses from individual sessions
 CPTDiffusionJSONTimeSeriesEventAn event in a time series whose value may be interpreted as JSON
 C<PTDiffusionJSONTimeSeriesEventValueStreamDelegate>Methods implemented by classes handling streamed time series events with JSON values
 CPTDiffusionJSONTimeSeriesQueryResultQuery result providing an array of JSON time series events
 CPTDiffusionJSONUpdateStreamAn update stream that provides the ability for updating topics with JSON values
 C<PTDiffusionJSONValueStreamDelegate>Methods implemented by classes handling streamed events for JSON value topics
 CPTDiffusionLoggingLogging provides access to debug information that can be enabled at runtime
 CPTDiffusionLoggingDestinationConfigurationOptions allowing log output to be directed to a custom location
 CPTDiffusionLoggingLevelA level of information events useful for debugging
 CPTDiffusionMessagingFeatureThis feature provides a client session with request-response messaging capabilities that can be used to implement application services
 CPTDiffusionMessagingFeature(PTDiffusionBinary)Extension adding support to the Messaging feature for sending requests accepting a binary response
 CPTDiffusionMessagingFeature(PTDiffusionJSON)Extension adding support to the Messaging feature for sending requests accepting a JSON response
 CPTDiffusionMessagingFeature(PTDiffusionPrimitive)Extension adding support to the Messaging feature for sending requests accepting a primitive value in response
 CPTDiffusionMessagingFeature(PTDiffusionRecordV2)Extension adding support to the Messaging feature for sending requests accepting a record response
 CPTDiffusionMetricCollectorThe common base interface for metric collectors
 CPTDiffusionMetricCollectorBuilderThe common base interface for metric collectors
 CPTDiffusionMetricsFeatureThis feature allows a client to configure metric collectors
 C<PTDiffusionMissingTopicHandler>Handler called when a client session subscribes or fetches using a topic selector that matches no topics
 CPTDiffusionMissingTopicNotificationNotification that a session has made a request using a selector that does not match any topics
 CPTDiffusionMutableRecordV2ModelA mutable data model based upon a schema
 CPTDiffusionMutableSessionConfigurationA mutable session configuration can be modified prior to being used to define behaviour and policies to use when connecting to Diffusion
 CPTDiffusionNumberFetchResultEncapsulates the results from a numeric fetch operation issued to the server
 CPTDiffusionNumberFetchTopicResultEncapsulates the result from a numeric fetch operation for a single selected topic
 C<PTDiffusionNumberRequestDelegate>Methods implemented by classes handling numeric messaging requests with a handler registered at the server
 C<PTDiffusionNumberRequestStreamDelegate>Methods implemented by classes handling Number messaging requests
 C<PTDiffusionNumberSessionResponseStreamDelegate>Methods implemented by classes handling numeric messaging responses from individual sessions
 CPTDiffusionNumberTimeSeriesEventAn event in a time series whose value may be interpreted as a number
 C<PTDiffusionNumberTimeSeriesEventValueStreamDelegate>Methods implemented by classes handling streamed time series events with numeric values
 CPTDiffusionNumberTimeSeriesQueryResultQuery result providing an array of number time series events
 CPTDiffusionNumberUpdateStreamAn update stream that provides the ability for updating topics with numerical primitive values
 C<PTDiffusionNumberValueStreamDelegate>Methods implemented by classes handling streamed events for number value topics
 CPTDiffusionPartialJSONUpdateConstraintA constraint requiring the current value of a JSON topic to match the partially described value
 CPTDiffusionPartialJSONUpdateConstraint(PTDiffusionBinary)Extension adding support to partial JSON update constraints for requiring primitive values at locations referenced with a JSON pointer
 CPTDiffusionPartialJSONUpdateConstraint(PTDiffusionPrimitive)Extension adding support to partial JSON update constraints for requiring primitive values at locations referenced with a JSON pointer
 CPTDiffusionPathPermissionPermissions protecting access-controlled operations that are evaluated for a specific topic path
 CPTDiffusionPingDetailsDetails returned in response to a ping to the server
 CPTDiffusionPingsFeatureThe Pings feature provides a client session with the ability to ping the server
 CPTDiffusionPrimaryInitiatorRemoteServerA Primary Initiator Remote Server
 CPTDiffusionPrimitiveSupport for creating value streams for primitive values including string and numeric types
 CPTDiffusionRecordV2An immutable record value with support for binary deltas
 CPTDiffusionRecordV2BuilderBuilds free format PTDiffusionRecordV2 values
 CPTDiffusionRecordV2DeltaA description of the differences between two record values
 CPTDiffusionRecordV2DeltaChangeRepresents a single change between one record value and another
 CPTDiffusionRecordV2DeltaChangeTypeThe type of change represented by a record delta
 CPTDiffusionRecordV2FetchResultEncapsulates the results from a record fetch operation issued to the server
 CPTDiffusionRecordV2FetchTopicResultEncapsulates the result from a record fetch operation for a single selected topic
 CPTDiffusionRecordV2ModelA data model based upon a schema
 C<PTDiffusionRecordV2RequestDelegate>Methods implemented by classes handling record messaging requests with a handler registered at the server
 C<PTDiffusionRecordV2RequestStreamDelegate>Methods implemented by classes handling RecordV2 messaging requests
 CPTDiffusionRecordV2SchemaA schema
 CPTDiffusionRecordV2SchemaBuilderUsed to build an immutable PTDiffusionRecordV2Schema
 CPTDiffusionRecordV2SchemaFieldA field definition within a schema
 CPTDiffusionRecordV2SchemaFieldTypeType of field defined within a schema
 CPTDiffusionRecordV2SchemaNodeA node within a schema
 CPTDiffusionRecordV2SchemaRecordA record definition within a schema
 C<PTDiffusionRecordV2SessionResponseStreamDelegate>Methods implemented by classes handling record messaging responses from individual sessions
 CPTDiffusionRecordV2TimeSeriesEventAn event in a time series whose value may be interpreted as a record
 C<PTDiffusionRecordV2TimeSeriesEventValueStreamDelegate>Methods implemented by classes handling streamed time series events with record values
 CPTDiffusionRecordV2TimeSeriesQueryResultQuery result providing an array of record time series events
 CPTDiffusionRecordV2UpdateStreamAn update stream that provides the ability for updating topics with record values
 C<PTDiffusionRecordV2ValueStreamDelegate>Methods implemented by classes handling streamed events for record value topics
 CPTDiffusionRecoverableUpdateStreamUpdate stream with recoverability capabilies regarding transient server errors
 CPTDiffusionRegistrationA reference to a registered handle
 CPTDiffusionRemoteServerBase Interface for a remote server
 CPTDiffusionRemoteServerBuilderA Remote Server builder
 CPTDiffusionRemoteServerConnectionOptionConnection option key for a remote server
 CPTDiffusionRemoteServerConnectionStateRepresents the current connection state of the remote server
 CPTDiffusionRemoteServersFeatureThis feature allows a client session to manage remote servers
 CPTDiffusionRequestA request to be sent using messaging
 CPTDiffusionRequestContextA request context provides additional contextual information for received messaging requests
 CPTDiffusionRequestHandlerHandler to receive request notifications
 CPTDiffusionRequestStreamA request stream represents an asynchronous, variable length feed of messaging requests
 CPTDiffusionResponderResponder provided with requests, used to dispatch responses
 CPTDiffusionResponder(PTDiffusionBinary)Extension adding support for responding to requests using Binary values
 CPTDiffusionResponder(PTDiffusionJSON)Extension adding support for responding to requests using JSON values
 CPTDiffusionResponder(PTDiffusionPrimitive)Extension adding support for responding to requests using primitive values
 CPTDiffusionResponder(PTDiffusionRecordV2)Extension adding support for responding to requests using record values
 CPTDiffusionResponseA response to be sent using messaging
 CPTDiffusionRetryStrategyDefines a retry strategy
 CPTDiffusionSecondaryAcceptorRemoteServerSecondary remote server that accepts a connection from a primary server
 CPTDiffusionSecondaryInitiatorRemoteServerSecondary remote server that initiates a connection to a primary server
 CPTDiffusionSecurityFeatureThis feature provides a client session with the ability to change its associated principal as well as to query permissions assigned to it
 CPTDiffusionSessionA client session to a server (or cluster of servers)
 CPTDiffusionSessionConfigurationA session configuration defines behavior and policies to use when connecting to Diffusion
 CPTDiffusionSessionDelayedReconnectionStrategyDelayed is a default reconnection strategy supplied with the client library
 CPTDiffusionSessionIdA session ID is a unique session identifier, allocated by the server
 CPTDiffusionSessionImmediateAbortReconnectionStrategyImmediate abort is a default reconnection strategy supplied with the client library
 CPTDiffusionSessionLockA server-managed resource that can be used to coordinate exclusive access to shared resources across sessions
 CPTDiffusionSessionLockAttemptA handle to a session lock request
 CPTDiffusionSessionLockScopeScope specifying when a session lock should be releaed
 CPTDiffusionSessionMetricCollectorThe definition of a session metric collector
 CPTDiffusionSessionMetricCollectorBuilderA session metric collector builder
 C<PTDiffusionSessionPropertiesDelegate>Listener for Session properties events from the server
 CPTDiffusionSessionPropertiesListenerRegistrationA reference to a handler registered for a particular set of session properties
 C<PTDiffusionSessionPropertiesListenerRegistrationDelegate>Common protocol for delegates that establish a server side control presence for the client session at a particular set of session properties
 CPTDiffusionSessionReconnectionAttemptA session reconnection attempt can either be started or aborted
 C<PTDiffusionSessionReconnectionStrategy>The session reconnection strategy protocol defines the behaviour for a session when recovering a failed connection
 CPTDiffusionSessionResponseStreamA response stream represents an asynchronous, variable length feed of messaging responses from other sessions
 C<PTDiffusionSessionResponseStreamDelegate>Methods implemented by classes handling messaging responses from individual sessions
 CPTDiffusionSessionStateSession state represents the condition a session has in respect of connectivity to a Diffusion server
 CPTDiffusionSessionStateChangeA session state change represents a change in a session's state
 C<PTDiffusionSessionStateChangeDelegate>The optional delegate for a session which may be used to receive state notifications
 CPTDiffusionSessionTreesFeatureThis feature allows a client session to configure session trees
 CPTDiffusionSetSessionPropertiesResultEncapsulates the result of a querying the server for the session properties of a particular session ID or session filter
 CPTDiffusionStreamA stream represents an asynchronous, variable length feed of updates from the Diffusion server
 C<PTDiffusionStreamDelegate>The stream delegate protocol defines the methods to be implemented by classes wishing to receive streaming updates
 CPTDiffusionStringFetchResultEncapsulates the results from a string fetch operation issued to the server
 CPTDiffusionStringFetchTopicResultEncapsulates the result from a string fetch operation for a single selected topic
 C<PTDiffusionStringRequestDelegate>Methods implemented by classes handling string messaging requests with a handler registered at the server
 C<PTDiffusionStringRequestStreamDelegate>Methods implemented by classes handling String messaging requests
 C<PTDiffusionStringSessionResponseStreamDelegate>Methods implemented by classes handling string messaging responses from individual sessions
 CPTDiffusionStringTimeSeriesEventAn event in a time series whose value may be interpreted as a string
 C<PTDiffusionStringTimeSeriesEventValueStreamDelegate>Methods implemented by classes handling streamed time series events with string values
 CPTDiffusionStringTimeSeriesQueryResultQuery result providing an array of string time series events
 CPTDiffusionStringUpdateStreamAn update stream that provides the ability for updating topics with string primitive values
 C<PTDiffusionStringValueStreamDelegate>Methods implemented by classes handling streamed events for string value topics
 C<PTDiffusionSubscriberStreamDelegate>Methods implemented by classes handling streamed subscription events for value topics
 CPTDiffusionSubscriptionControlFeatureThe Subscription Control feature allows a client session to subscribe or unsubscribe other sessions to topics, on a single server or across a cluster
 CPTDiffusionTimeSeriesEventAn event in a time series
 CPTDiffusionTimeSeriesEventMetadataMetadata associated with a time series event
 CPTDiffusionTimeSeriesFeatureThis feature allows a session to update and query time series topics
 CPTDiffusionTimeSeriesFeature(PTDiffusionBinary)Extension adding support to the Time Series feature for appending and editing events using binary values
 CPTDiffusionTimeSeriesFeature(PTDiffusionJSON)Extension adding support to the Time Series feature for appending and editing events using JSON values
 CPTDiffusionTimeSeriesFeature(PTDiffusionPrimitive)Extension adding support to the Time Series feature for appending and editing events using primitive values
 CPTDiffusionTimeSeriesFeature(PTDiffusionRecordV2)Extension adding support to the Time Series feature for appending and editing events using record values
 CPTDiffusionTimeSeriesFetchResultEncapsulates the results from a time series fetch operation issued to the server
 CPTDiffusionTimeSeriesFetchTopicResultEncapsulates the result from a time series fetch operation for a single selected topic
 CPTDiffusionTimeSeriesQueryResultQuery result providing an array of time series events
 CPTDiffusionTimeSeriesQueryResultEventArrayStructureDescribes the structural properties of the array of events presented by a time series query result
 CPTDiffusionTimeSeriesRangeQueryBuilder for queries that select a range of events from a time series
 CPTDiffusionTopicControlFeatureThe Topic Control feature provides a client session with the ability to manage topics
 CPTDiffusionTopicCreationResultIndicates whether the operation caused a topic to be created or if it already existed
 CPTDiffusionTopicMetricCollectorThe definition of a topic metric collector
 CPTDiffusionTopicMetricCollectorBuilderA topic metric collector builder
 C<PTDiffusionTopicNotificationListener>Methods implemented by classes handling streamed topic notifications
 CPTDiffusionTopicNotificationRegistrationThe registration state of the associated topic notification listener on the server
 CPTDiffusionTopicNotificationsFeatureThe Topic Notifications feature allows a client session to receive notifications about changes to selected topics
 CPTDiffusionTopicNotificationTypeThe type of topic notification received
 CPTDiffusionTopicRemovalResultReports the number of topics removed by a call to removeTopicsWithTopicSelectorExpression
 CPTDiffusionTopicSelectionA topic selection that represents either a subscription (selection) or an unsubscription (deselection)
 CPTDiffusionTopicSelectorA topic selector identifies one or more topics
 CPTDiffusionTopicsFeatureSubscription to topics and fetching topic data
 CPTDiffusionTopicSpecificationTopic specifications provide the information required to create a topic
 CPTDiffusionTopicTreeRegistrationA reference to a handler registered for a particular topic path
 C<PTDiffusionTopicTreeRegistrationDelegate>Common protocol for delegates that establish a server side control presence for the client session at a particular branch of the topic tree
 CPTDiffusionTopicUpdateFeatureThe Topic Update feature provides a client session with the ability to update topics
 CPTDiffusionTopicUpdateFeature(PTDiffusionBinary)Extension adding support to the Topic Update feature for updating topics with binary values
 CPTDiffusionTopicUpdateFeature(PTDiffusionJSON)Extension adding support to the Topic Update feature for updating topics with JSON values
 CPTDiffusionTopicUpdateFeature(PTDiffusionPrimitive)Extension adding support to the Topic Update feature for updating topics with primitive values
 CPTDiffusionTopicUpdateFeature(PTDiffusionRecordV2)Extension adding support to the Topic Update feature for updating topics with record values
 CPTDiffusionTopicViewDescription of a topic view that has been created
 CPTDiffusionTopicViewsFeatureThis feature allows a client session to manage topic views
 CPTDiffusionUpdateConstraintA constraint to be applied to an update operation or the creation of an update stream
 CPTDiffusionUpdateConstraintOperatorAn operator used in a constraint comparison
 CPTDiffusionUpdateStreamAn update stream that provides a base functionality for updating a specific topic
 CPTDiffusionUpdateStreamBuilderAn update stream builder
 CPTDiffusionValueStreamA value stream represents an asynchronous, variable length feed of subscription and value updates from the Diffusion server
 CPTDiffusionVersionA version represents a released build of the client library