 |
Diffusion Apple API
5.9.24
Unified Client Library for iOS, OS X and tvOS
|
|
Diffusion Apple API
5.9.24
Unified Client Library for iOS, OS X and tvOS
|
The Topic Control feature provides a client session with the ability to manage topics.
The Topic Control feature for a session can be obtained from the session's topicControl property.
Additional Inherited Members | |
 Properties inherited from PTDiffusionFeature | |
| PTDiffusionSession * | session |
| - (void) addMissingTopicHandler: | (id< PTDiffusionMissingTopicHandler >) | handler | |
| forTopicPath: | (NSString *) | topicPath | |
| completionHandler: | (PTDiffusionTopicTreeRegistration *_Nullable) | registration | |
| (NSError *_Nullable error) | completionHandler | ||
Register a handler of requests for a branch of the topic tree.
The provided handler is called when a client subscribes or fetches using a topic selector that matches no existing topics. This allows a control client to intercede when another session requests a topic that does not exist. The control client may use any of the add topic methods to create the topic, take some other action, or do nothing, before allowing the client operation to proceed by calling proceed. Alternatively, the control client can call cancel to discard the request.
A control client can register multiple handlers, but may only register a single handler for a given topic path. A handler will only be called for topic selectors with a path prefix that starts with or is equal to topicPath. If the path prefix matches multiple handlers, the one registered for the most specific (longest) topic path will be called.
| handler | The handler to use for the topic tree branch identified by the given topicPath (unless overridden by a handler registered against a more specific branch). |
| topicPath | Identifies a branch of the topic tree. |
| completionHandler | Block to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil and the registration argument will not be nil. The completion handler will be called asynchronously on the main dispatch queue. |
| NSInvalidArgumentException | If any argument is nil. |
| - (void) addTopicEventListener: | (id< PTDiffusionTopicEventListener >) | listener | |
| forTopicPath: | (NSString *) | topicPath | |
| completionHandler: | (PTDiffusionTopicTreeRegistration *_Nullable) | registration | |
| (NSError *_Nullable error) | completionHandler | ||
Register a listener to receive topic events for a branch of the topic tree.
This allows a client to receive different events for topics. These events are emitted when a topic is subscribed to by one or more sessions after previously having no subscribers, or when a topic is no longer subscribed to by any session. These events are averaged over a small window of time to prevent rapid dispatch of events that ultimately return a topic to it's previous state.
Each control session may register a single handler for a branch.
| listener | Specifies the listener for the specified branch (unless overriden by a listener registered against a more specific branch). |
| topicPath | Identifies a branch of the topic tree. |
| completionHandler | Block to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil and the registration argument will not be nil. The completion handler will be called asynchronously on the main dispatch queue. |
| NSInvalidArgumentException | If any argument is nil. |
| - (void) addWithTopicPath: | (NSString *) | topicPath | |
| details: | (PTDiffusionTopicDetails *) | details | |
| content: | (nullable PTDiffusionContent *) | content | |
| completionHandler: | (NSError *_Nullable error) | __deprecated | |
Send a request to the server to add a topic.
The topic will be initialized with the given content, if specified non-nil, during creation and therefore the content must be compatible with the topic type.
| topicPath | The full path of the topic to be created. |
| details | Defines the topic to be created. |
| content | The initial value. If this is specified as nil then the default initial value for the topic type will be used. A value may only be supplied for a topic that is stateful. |
| completionHandler | Block to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue. |
| NSInvalidArgumentException | If any argument is nil or content has been supplied for a topic type that is not stateful. |
| - (void) addWithTopicPath: | (NSString *) | topicPath | |
| details: | (PTDiffusionTopicDetails *) | details | |
| value: | (nullable PTDiffusionBytes *) | value | |
| completionHandler: | (NSError *_Nullable error) | completionHandler | |
Send a request to the server to add a topic.
The topic will be initialized with the given value, if specified non-nil, during creation and therefore the value must be compatible with the topic type.
| topicPath | The full path of the topic to be created. |
| details | Defines the topic to be created. |
| value | The initial value. If this is specified as nil then the default initial value for the topic type will be used. A value may only be supplied for a topic that is stateful. |
| completionHandler | Block to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue. |
| NSInvalidArgumentException | If any argument is nil or value has been supplied for a topic type that is not stateful. |
| - (void) addWithTopicPath: | (NSString *) | topicPath | |
| type: | (PTDiffusionTopicType) | type | |
| content: | (nullable PTDiffusionContent *) | content | |
| completionHandler: | (NSError *_Nullable error) | __deprecated | |
Send a request to the server to add a topic.
This is a convenience method which creates the topic with default details for the given type.
The topic will be initialized with the given content, if specified non-nil, during creation and therefore the content must be compatible with the topic type.
| topicPath | The full path of the topic to be created. |
| type | The type of topic to be created. |
| content | The initial value. If this is specified as nil then the default initial value for the topic type will be used. A value may only be supplied for a topic that is stateful. |
| completionHandler | Block to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue. |
| NSInvalidArgumentException | If any argument is nil or content has been supplied for a topic type that is not stateful. |
| - (void) addWithTopicPath: | (NSString *) | topicPath | |
| type: | (PTDiffusionTopicType) | type | |
| value: | (nullable PTDiffusionBytes *) | value | |
| completionHandler: | (NSError *_Nullable error) | completionHandler | |
Send a request to the server to add a topic.
This is a convenience method which creates the topic with default details for the given type.
The topic will be initialized with the given value, if specified non-nil, during creation and therefore the value must be compatible with the topic type.
| topicPath | The full path of the topic to be created. |
| type | The type of topic to be created. |
| value | The initial value. If this is specified as nil then the default initial value for the topic type will be used. A value may only be supplied for a topic that is stateful. |
| completionHandler | Block to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue. |
| NSInvalidArgumentException | If any argument is nil or value has been supplied for a topic type that is not stateful. |
| - (void) removeDiscreteWithTopicSelectorExpression: | (NSString *) | expression | |
| completionHandler: | (NSError *_Nullable error) | completionHandler | |
Send a request to remove one or more topics at the server.
Any descendants of the matched topics are unaffected.
| expression | The topic selector expression to be evaluated by the server. |
| completionHandler | Block to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue. |
| NSInvalidArgumentException | If any argument is nil. |
| - (void) removeTopicsWithSessionForTopicPath: | (NSString *) | topicPath | |
| delegate: | (id< PTDiffusionTopicTreeRegistrationDelegate >) | delegate | |
| completionHandler: | (PTDiffusionTopicTreeRegistration *_Nullable) | registration | |
| (NSError *_Nullable error) | completionHandler | ||
Register a deferred action to remove a branch of the topic tree. The server will remove the topics if this session is closed. If several client sessions request removal of the same branch, the topics will not be removed until the last session is closed.
For example, suppose two client sessions both call register expression "a/b". When both sessions are closed, either explicitly or by the server, the topic a/b and all of its descendants will be removed. This method is typically used by a client that has added one or more topics to tidy up and remove the topics if it is ever disconnected from the server or otherwise fails.
The server can reject a request if the topicPath conflicts with existing registrations. Different sessions may call this method for the same topic path, but not for topic paths above or below existing registrations on the same branch of the topic tree.
The last session to close must have MODIFY_TOPIC permission for topicPath. If this is not the case, none of the topic or its descendants will be removed.
| topicPath | Identifies a branch of the topic tree. This topic and its descendants will be removed if the action is executed. |
| delegate | The delegate to be informed of lifecycle events in respect of this registration. |
| completionHandler | Block to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil and the registration argument will not be nil. The completion handler will be called asynchronously on the main dispatch queue. |
| NSInvalidArgumentException | If any argument is nil. |
| - (void) removeWithTopicSelectorExpression: | (NSString *) | expression | |
| completionHandler: | (NSError *_Nullable error) | __deprecated | |
Send a request to remove one or more topics at the server.
Any descendants of the matched topics will also be removed.
| expression | The topic selector expression to be evaluated by the server. |
| completionHandler | Block to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue. |
| NSInvalidArgumentException | If any argument is nil. |
1.8.5
