Diffusion Apple API
6.1.5
Unified Client Library for iOS, tvOS and OS X / macOS
|
A session represents a single connection to a single Diffusion server.
The Quick Start guide provides basic instructions on how to get connected to a Diffusion server.
Class Methods | |
(instancetype) | + NS_UNAVAILABLE |
(void) | + openWithURL:configuration:completionHandler: |
(void) | + openWithURL:completionHandler: |
(NSString *) | + anonymousPrincipal |
(NSString *) | + allFixedProperties |
(NSString *) | + allUserProperties |
Instance Methods | |
(instancetype) | - NS_UNAVAILABLE |
(void) | - close |
+ (NSString *) allFixedProperties |
This constant can be used instead of a property key in requests for session property values to indicate that all fixed session properties are required.
+ (NSString *) allUserProperties |
This constant can be used instead of a property key in requests for session property values to indicate that all user defined session properties are required.
+ (NSString *) anonymousPrincipal |
Value assigned to the principal property if this is an anonymous session.
- (void) close |
Close the session. Once closed a session cannot be restarted.
+ (void) openWithURL: | (NSURL *) | url | |
completionHandler: | (PTDiffusionSession *_Nullable) | session | |
(NSError *_Nullable error) | completionHandler | ||
Starts asynchronously connecting to a Diffusion server using the default session configuration.
url | The location of the server to connect to. Encapsulates host, port and protocol to use. Must be absolute. |
completionHandler | The completion handler to call on connection success or failure. The completion handler will be called from the main dispatch queue and will only be called once. |
+ (void) openWithURL: | (NSURL *) | url | |
configuration: | (PTDiffusionSessionConfiguration *) | configuration | |
completionHandler: | (PTDiffusionSession *_Nullable) | session | |
(NSError *_Nullable error) | completionHandler | ||
Starts asynchronously connecting to a Diffusion server using the given session configuration.
url | The location of the server to connect to. Encapsulates host, port and protocol to use. Must be absolute. |
configuration | The configuration options to connect with. |
completionHandler | The completion handler to call on connection success or failure. The completion handler will be called from the main dispatch queue and will only be called once. |
|
readnonatomiccopy |
The configuration used to open the session.
|
readwritenonatomicweak |
The delegate to use to report unexpected, non-fatal errors to.
|
readnonatomicassign |
The Messaging feature provides messaging capabilities.
|
readnonatomicassign |
The Messaging Control feature provides the capability to use messaging functionality to communicate directly with other client sessions.
|
readnonatomicassign |
The Pings feature provides a client session with the ability to test the roundtrip time associated with sending a request to the server and receiving the associated response.
|
readnonatomicassign |
The name of the security principal associated with the session.
|
readnonatomicassign |
The Security feature provides a client session with the ability to change the associated principal.
|
readnonatomicassign |
The unique identifier for the session as assigned by the server it connects to.
This property is Key-Value Observable with changes being notified on the main dispatch queue.
|
readnonatomicassign |
The current state of the session.
This property is Key-Value Observable with changes being notified on the main dispatch queue. KVO notifications are sent before the invocation of any callback handler blocks.
|
readnonatomicassign |
The 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.
|
readnonatomicassign |
The Time Series feature provides a client session with the ability to update and query time series topics.
|
readnonatomicassign |
The Topic Control features provides the capability to manage topics.
|
readnonatomicassign |
The Topic Notifications feature allows a client session to receive notifications about changes to selected topics.
|
readnonatomicassign |
The Topics feature provides the capability to receive streamed topic updates and/or fetch the state of topics.
|
readnonatomicassign |
The Topic Update Control feature provides the capability to update topics.