![]() |
Diffusion Apple API 6.12.1
Unified Client Library for iOS, tvOS and OS X / macOS
|
| CPTDiffusionAddTopicResult | The result of adding a topic |
| CPTDiffusionBasicHTTPProxyAuthentication | Provider of responses to basic authentication challenges from HTTP proxies |
| CPTDiffusionBinary | An immutable binary value with support for binary deltas |
| CPTDiffusionBinaryDelta | An immutable delta describing the differences between two binary values |
| CPTDiffusionBinaryFetchResult | Encapsulates the results from a binary fetch operation issued to the server |
| CPTDiffusionBinaryFetchTopicResult | Encapsulates 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 |
| CPTDiffusionBinaryTimeSeriesEvent | An 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 |
| CPTDiffusionBinaryTimeSeriesQueryResult | Query result providing an array of binary time series events |
| CPTDiffusionBinaryUpdateStream | An 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 |
| CPTDiffusionBranchMapping | A session tree branch mapping |
| CPTDiffusionBranchMappingTable | A session tree branch mapping table |
| CPTDiffusionBranchMappingTableBuilder | Builder for PTDiffusionBranchMappingTable instances |
| CPTDiffusionBytes | A value that is internally represented as binary data |
| C<PTDiffusionCancellable> | A cancellable handle to an asynchronous operation |
| CPTDiffusionCheckRemoteServerResult | Interface for the result of checking the state of a remote server |
| CPTDiffusionClientControlFeature | The 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 |
| CPTDiffusionClientQueuePolicy | Policy for managing a client message queue |
| CPTDiffusionCloseReason | Specifies the reason why a session has been closed |
| CPTDiffusionCreateRemoteServerResult | Interface for the result from the creation of a remote server |
| CPTDiffusionCredentials | Credentials contain the proof material to support an authentication request |
| C<PTDiffusionDataType> | Methods implemented by classes providing data type implementations |
| CPTDiffusionDataTypes | Diffusion data type implementations |
| CPTDiffusionDefaultSessionResponseStreamDelegate | Default delegate implementation which may be used as an abstract base for sub-protocol implementations |
| CPTDiffusionDefaultStreamDelegate | Default delegate implementation which may be used as an abstract base for sub-protocol implementations |
| CPTDiffusionDefaultSubscriberStreamDelegate | Default delegate implementation which may be used as an abstract base for sub-protocol implementations |
| CPTDiffusionDefaultTopicNotificationListener | Default delegate implementation which may be used as an abstract base for sub-protocol implementations |
| CPTDiffusionDefaultTopicTreeRegistrationDelegate | Default delegate implementation which may be used as an abstract base for sub-protocol implementations |
| CPTDiffusionEnumeration | Base class for objects offering a selection of predefined constant values |
| C<PTDiffusionErrorListener> | Methods implemented by classes wishing to listen to error notifications |
| CPTDiffusionFeature | A feature is a unit of functionality that is available to a client session |
| CPTDiffusionFetchRequest | A 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 |
| CPTDiffusionFetchResult | Base class for results from fetch operations issued to the server |
| CPTDiffusionFetchTopicResult | Encapsulates the result from a fetch operation for a single selected topic |
| CPTDiffusionGetSessionPropertiesResult | Encapsulates the result of a querying the server for the session properties of a particular session ID or session filter |
| CPTDiffusionGlobalPermission | Permissions that protect globally scoped, access-controlled operations |
| C<PTDiffusionHTTPAuthentication> | The protocol implemented by classes providing authentication challenge handler implementations for HTTP connections |
| CPTDiffusionHTTPAuthenticationChallenge | An 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 |
| CPTDiffusionHTTPAuthenticationChallengeStatus | An HTTP Status received as part of an authentication challenge |
| CPTDiffusionHTTPProxyConfiguration | Connection details for an HTTP proxy to be tunneled through in order to reach the Diffusion server |
| CPTDiffusionHTTPResponse | |
| CPTDiffusionJSON | An immutable JSON value with support for both binary and JSON deltas |
| CPTDiffusionJSONDelta | An immutable structural delta describing the differences between two JSON values |
| CPTDiffusionJSONDeltaChangeMap | An immutable map describing the changes to a JSON value |
| CPTDiffusionJSONFetchResult | Encapsulates the results from a JSON fetch operation issued to the server |
| CPTDiffusionJSONFetchTopicResult | Encapsulates the result from a JSON fetch operation for a single selected topic |
| CPTDiffusionJSONPatchResult | Result 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 |
| CPTDiffusionJSONTimeSeriesEvent | An 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 |
| CPTDiffusionJSONTimeSeriesQueryResult | Query result providing an array of JSON time series events |
| CPTDiffusionJSONUpdateStream | An 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 |
| CPTDiffusionLogging | Logging provides access to debug information that can be enabled at runtime |
| CPTDiffusionLoggingDestinationConfiguration | Options allowing log output to be directed to a custom location |
| CPTDiffusionLoggingLevel | A level of information events useful for debugging |
| CPTDiffusionMessagingFeature | This 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 |
| CPTDiffusionMetricCollector | The common base interface for metric collectors |
| CPTDiffusionMetricCollectorBuilder | The common base interface for metric collectors |
| CPTDiffusionMetricsFeature | This 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 |
| CPTDiffusionMissingTopicNotification | Notification that a session has made a request using a selector that does not match any topics |
| CPTDiffusionMutableRecordV2Model | A mutable data model based upon a schema |
| CPTDiffusionMutableSessionConfiguration | A mutable session configuration can be modified prior to being used to define behaviour and policies to use when connecting to Diffusion |
| CPTDiffusionNumberFetchResult | Encapsulates the results from a numeric fetch operation issued to the server |
| CPTDiffusionNumberFetchTopicResult | Encapsulates 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 |
| CPTDiffusionNumberTimeSeriesEvent | An 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 |
| CPTDiffusionNumberTimeSeriesQueryResult | Query result providing an array of number time series events |
| CPTDiffusionNumberUpdateStream | An 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 |
| CPTDiffusionPartialJSONUpdateConstraint | A 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 |
| CPTDiffusionPathPermission | Permissions protecting access-controlled operations that are evaluated for a specific topic path |
| CPTDiffusionPingDetails | Details returned in response to a ping to the server |
| CPTDiffusionPingsFeature | The Pings feature provides a client session with the ability to ping the server |
| CPTDiffusionPrimaryInitiatorRemoteServer | A Primary Initiator Remote Server |
| CPTDiffusionPrimitive | Support for creating value streams for primitive values including string and numeric types |
| CPTDiffusionRecordV2 | An immutable record value with support for binary deltas |
| CPTDiffusionRecordV2Builder | Builds free format PTDiffusionRecordV2 values |
| CPTDiffusionRecordV2Delta | A description of the differences between two record values |
| CPTDiffusionRecordV2DeltaChange | Represents a single change between one record value and another |
| CPTDiffusionRecordV2DeltaChangeType | The type of change represented by a record delta |
| CPTDiffusionRecordV2FetchResult | Encapsulates the results from a record fetch operation issued to the server |
| CPTDiffusionRecordV2FetchTopicResult | Encapsulates the result from a record fetch operation for a single selected topic |
| CPTDiffusionRecordV2Model | A 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 |
| CPTDiffusionRecordV2Schema | A schema |
| CPTDiffusionRecordV2SchemaBuilder | Used to build an immutable PTDiffusionRecordV2Schema |
| CPTDiffusionRecordV2SchemaField | A field definition within a schema |
| CPTDiffusionRecordV2SchemaFieldType | Type of field defined within a schema |
| CPTDiffusionRecordV2SchemaNode | A node within a schema |
| CPTDiffusionRecordV2SchemaRecord | A record definition within a schema |
| C<PTDiffusionRecordV2SessionResponseStreamDelegate> | Methods implemented by classes handling record messaging responses from individual sessions |
| CPTDiffusionRecordV2TimeSeriesEvent | An 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 |
| CPTDiffusionRecordV2TimeSeriesQueryResult | Query result providing an array of record time series events |
| CPTDiffusionRecordV2UpdateStream | An 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 |
| CPTDiffusionRecoverableUpdateStream | Update stream with recoverability capabilies regarding transient server errors |
| CPTDiffusionRegistration | A reference to a registered handle |
| CPTDiffusionRemoteServer | Base Interface for a remote server |
| CPTDiffusionRemoteServerBuilder | A Remote Server builder |
| CPTDiffusionRemoteServerConnectionOption | Connection option key for a remote server |
| CPTDiffusionRemoteServerConnectionState | Represents the current connection state of the remote server |
| CPTDiffusionRemoteServersFeature | This feature allows a client session to manage remote servers |
| CPTDiffusionRequest | A request to be sent using messaging |
| CPTDiffusionRequestContext | A request context provides additional contextual information for received messaging requests |
| CPTDiffusionRequestHandler | Handler to receive request notifications |
| CPTDiffusionRequestStream | A request stream represents an asynchronous, variable length feed of messaging requests |
| CPTDiffusionResponder | Responder 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 |
| CPTDiffusionResponse | A response to be sent using messaging |
| CPTDiffusionRetryStrategy | Defines a retry strategy |
| CPTDiffusionSecondaryAcceptorRemoteServer | Secondary remote server that accepts a connection from a primary server |
| CPTDiffusionSecondaryInitiatorRemoteServer | Secondary remote server that initiates a connection to a primary server |
| CPTDiffusionSecurityFeature | This feature provides a client session with the ability to change its associated principal as well as to query permissions assigned to it |
| CPTDiffusionSession | A client session to a server (or cluster of servers) |
| CPTDiffusionSessionConfiguration | A session configuration defines behavior and policies to use when connecting to Diffusion |
| CPTDiffusionSessionDelayedReconnectionStrategy | Delayed is a default reconnection strategy supplied with the client library |
| CPTDiffusionSessionId | A session ID is a unique session identifier, allocated by the server |
| CPTDiffusionSessionImmediateAbortReconnectionStrategy | Immediate abort is a default reconnection strategy supplied with the client library |
| CPTDiffusionSessionLock | A server-managed resource that can be used to coordinate exclusive access to shared resources across sessions |
| CPTDiffusionSessionLockAttempt | A handle to a session lock request |
| CPTDiffusionSessionLockScope | Scope specifying when a session lock should be releaed |
| CPTDiffusionSessionMetricCollector | The definition of a session metric collector |
| CPTDiffusionSessionMetricCollectorBuilder | A session metric collector builder |
| C<PTDiffusionSessionPropertiesDelegate> | Listener for Session properties events from the server |
| CPTDiffusionSessionPropertiesListenerRegistration | A 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 |
| CPTDiffusionSessionReconnectionAttempt | A 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 |
| CPTDiffusionSessionResponseStream | A 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 |
| CPTDiffusionSessionState | Session state represents the condition a session has in respect of connectivity to a Diffusion server |
| CPTDiffusionSessionStateChange | A 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 |
| CPTDiffusionSessionTreesFeature | This feature allows a client session to configure session trees |
| CPTDiffusionSetSessionPropertiesResult | Encapsulates the result of a querying the server for the session properties of a particular session ID or session filter |
| CPTDiffusionStream | A 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 |
| CPTDiffusionStringFetchResult | Encapsulates the results from a string fetch operation issued to the server |
| CPTDiffusionStringFetchTopicResult | Encapsulates 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 |
| CPTDiffusionStringTimeSeriesEvent | An 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 |
| CPTDiffusionStringTimeSeriesQueryResult | Query result providing an array of string time series events |
| CPTDiffusionStringUpdateStream | An 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 |
| CPTDiffusionSubscriptionControlFeature | The Subscription Control feature allows a client session to subscribe or unsubscribe other sessions to topics, on a single server or across a cluster |
| CPTDiffusionTimeSeriesEvent | An event in a time series |
| CPTDiffusionTimeSeriesEventMetadata | Metadata associated with a time series event |
| CPTDiffusionTimeSeriesFeature | This 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 |
| CPTDiffusionTimeSeriesFetchResult | Encapsulates the results from a time series fetch operation issued to the server |
| CPTDiffusionTimeSeriesFetchTopicResult | Encapsulates the result from a time series fetch operation for a single selected topic |
| CPTDiffusionTimeSeriesQueryResult | Query result providing an array of time series events |
| CPTDiffusionTimeSeriesQueryResultEventArrayStructure | Describes the structural properties of the array of events presented by a time series query result |
| CPTDiffusionTimeSeriesRangeQuery | Builder for queries that select a range of events from a time series |
| CPTDiffusionTopicControlFeature | The Topic Control feature provides a client session with the ability to manage topics |
| CPTDiffusionTopicCreationResult | Indicates whether the operation caused a topic to be created or if it already existed |
| CPTDiffusionTopicMetricCollector | The definition of a topic metric collector |
| CPTDiffusionTopicMetricCollectorBuilder | A topic metric collector builder |
| C<PTDiffusionTopicNotificationListener> | Methods implemented by classes handling streamed topic notifications |
| CPTDiffusionTopicNotificationRegistration | The registration state of the associated topic notification listener on the server |
| CPTDiffusionTopicNotificationsFeature | The Topic Notifications feature allows a client session to receive notifications about changes to selected topics |
| CPTDiffusionTopicNotificationType | The type of topic notification received |
| CPTDiffusionTopicRemovalResult | Reports the number of topics removed by a call to removeTopicsWithTopicSelectorExpression |
| CPTDiffusionTopicSelection | A topic selection that represents either a subscription (selection) or an unsubscription (deselection) |
| CPTDiffusionTopicSelector | A topic selector identifies one or more topics |
| CPTDiffusionTopicsFeature | Subscription to topics and fetching topic data |
| CPTDiffusionTopicSpecification | Topic specifications provide the information required to create a topic |
| CPTDiffusionTopicTreeRegistration | A 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 |
| CPTDiffusionTopicUpdateFeature | The 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 |
| CPTDiffusionTopicView | Description of a topic view that has been created |
| CPTDiffusionTopicViewsFeature | This feature allows a client session to manage topic views |
| CPTDiffusionUpdateConstraint | A constraint to be applied to an update operation or the creation of an update stream |
| CPTDiffusionUpdateConstraintOperator | An operator used in a constraint comparison |
| CPTDiffusionUpdateStream | An update stream that provides a base functionality for updating a specific topic |
| CPTDiffusionUpdateStreamBuilder | An update stream builder |
| CPTDiffusionValueStream | A value stream represents an asynchronous, variable length feed of subscription and value updates from the Diffusion server |
| CPTDiffusionVersion | A version represents a released build of the client library |