Diffusion .NET Client Library  6.1.5
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
PushTechnology.ClientInterface.Client.Features.Control.Topics.IMissingTopicHandler Interface Reference

The handler that will be called when a session subscribes or fetches using a topic selector that matches no topics. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Features.Control.Topics.IMissingTopicHandler:
PushTechnology.ClientInterface.Client.Features.ITopicTreeHandler PushTechnology.ClientInterface.Client.Features.Control.Topics.MissingTopicHandlerDefault

Public Member Functions

void OnMissingTopic (IMissingTopicNotification notification)
 Called when a session requests a topic that does not exist, and the topic path belongs to part of the topic tree for which this handler was registered. More...
 
- Public Member Functions inherited from PushTechnology.ClientInterface.Client.Features.ITopicTreeHandler
void OnActive (string topicPath, IRegisteredHandler registeredHandler)
 Called when the handler has been registered at the server and is now active. More...
 
void OnClose (string topicPath)
 Called if the handler is closed. More...
 

Detailed Description

The handler that will be called when a session subscribes or fetches using a topic selector that matches no topics.

Handler instances can be registered using ITopicControl.AddMissingTopicHandler.

Member Function Documentation

void PushTechnology.ClientInterface.Client.Features.Control.Topics.IMissingTopicHandler.OnMissingTopic ( IMissingTopicNotification  notification)

Called when a session requests a topic that does not exist, and the topic path belongs to part of the topic tree for which this handler was registered.

The implementation should take the appropriate action (for example, create the topic), and then call IMissingTopicNotification.Proceed() on the given notification . This allows the session request to continue and successfully resolve against the topic if it was created.

Alternatively, the handler can call IMissingTopicNotification.Cancel() to discard the request. A handler should always call IMissingTopicNotification.Proceed() or IMissingTopicNotification.Cancel(), otherwise resources will continue to be reserved on the server and the session's request will not complete.

Parameters
notificationThe missing topic notification.

Implemented in PushTechnology.ClientInterface.Client.Features.Control.Topics.MissingTopicHandlerDefault.


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