DEPRECATED: Diffusion iOS Classic API  5.9.4
 All Data Structures Files Functions Variables Enumerations Enumerator Properties Macros Pages
DFTopicNotifyTopicHandler Class Reference

A Topic Notify Topic Handler. More...

#import <DFTopicNotifyTopicHandler.h>

Inheritance diagram for DFTopicNotifyTopicHandler:
Collaboration diagram for DFTopicNotifyTopicHandler:

Instance Methods

(void) - setNotification:removal:andUpdate:
 This can be used to set the notification details required.
 
- Instance Methods inherited from <DFTopicListenerDelegate>
(BOOL) - onMessage:
 This method is called if the TopicMessage matches the message received from Diffusion.
 
(NSString *) - getTopic
 getTopic.
 

Properties

DFNotificationLevel notificationLevel
 This can be used to get the notification level from that initially specified.
 
BOOL notifiesUpdate
 Indicates whether notifying topic removals.
 
BOOL notifiesRemoval
 Indicates whether notifying topic property updates.
 
DFClientconnection
 Returns the client connection.
 

Detailed Description

A Topic Notify Topic Handler.

This is an object which is used to send commands to a 'Topic Notify' Topic. (see TopicNotifyTopicData). The handler simplifies the use of such a Topic and avoids having to format messages to send to the Topic or parse messages received from it.

Such a handler is created using [DFClient createTopicNotifyTopicHandlerWithMessage:level:andDelegate:] and all notifications from the Topic will be routed through the supplied delegate.

When such a handler is in use then messages received on the Topic will not be delivered via normal listener mechanisms but will be parsed and notified to the DFTopicNotifyTopicDelegate specified.

When the handler is created the Notification Level required is specified. This indicates how much detail is required when each Topic addition is notified.

After creating the handler you can use it to specify the range of topics that notifications are required for. This is done using the select:forTopicSet: method which may be used to add, replace, remove or clear selections.

Method Documentation

- (void) setNotification: (DFNotificationLevel addLevel
removal: (BOOL)  notifyRemoval
andUpdate: (BOOL)  notifyUpdate 

This can be used to set the notification details required.

If this is not called then the default will be DTM_MINIMUM with no deletions or updates notified.

This will send a message to the server requesting a change in the notification level and therefore should ideally be called before any call to DFTopicNotifyTopicHandler::select:forTopicSet: otherwise the effect will be delayed.

Parameters
addLevelthe required notification level for add notifications
notifyRemovalYES to request notifications of topic removals
notifyUpdateYES to request notifications of updates to those topic properties that can be changed after the topic as been created.
Since
4.6

The documentation for this class was generated from the following file: