PushTechnology.ClientInterface.Client.Features.Control.Topics.IMissingTopicHandler Interface Reference

Handler called when a client session subscribes or fetches using a topic selector that matches no topics. More...

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

Public Member Functions
void	OnMissingTopic (IMissingTopicNotification notification)
	Called when a client 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 successfully registered with the server. More...
void	OnClose (string topicPath)
	Called if the handler is closed. This happens if the call to register the handler fails, or the handler is unregistered. More...

Detailed Description

Handler called when a client 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 client 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 handler implementation should take the appropriate action (for example, create the topic), and then call IMissingTopicNotification.Proceed on the supplied notification. This allows the client 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 Proceed() or Cancel(), otherwise resources will continue to be reserved on the server and the client's request will not complete.

Parameters

notification

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

---

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

• UCIStack/Client/Features/Control/Topics/IMissingTopicHandler.cs