PushTechnology.ClientInterface.Client.Features.ITopicTreeHandler Interface Reference

Common base interface for callback handlers registered via the client session that establish a server-side control presence for a particular node (and descendants) in the topic tree. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Features.ITopicTreeHandler:

Public Member Functions
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

Common base interface for callback handlers registered via the client session that establish a server-side control presence for a particular node (and descendants) in the topic tree.

Member Function Documentation

void PushTechnology.ClientInterface.Client.Features.ITopicTreeHandler.OnActive	(	string	topicPath,
		IRegisteredHandler	registeredHandler
	)

Called when the handler has been successfully registered with the server.

A session can register a single handler of each type for a given branch of the topic tree. If there is already a handler registered for the topic path the operation will fail, registeredHandler will be closed, and the session error handler will be notified. To change the handler, first close the previous handler.

Parameters

topicPath	The path that the handler is active for.
registeredHandler	Allows the handler to be closed.

Implemented in PushTechnology.ClientInterface.Client.Features.Control.Topics.MessageReceiverDefault, and PushTechnology.ClientInterface.Client.Features.TopicTreeHandlerDefault.

void PushTechnology.ClientInterface.Client.Features.ITopicTreeHandler.OnClose

(

string

topicPath

)

Called if the handler is closed. This happens if the call to register the handler fails, or the handler is unregistered.

Parameters

topicPath

The branch of the topic tree for which the handler was registered.

Implemented in PushTechnology.ClientInterface.Client.Features.Control.Topics.MessageReceiverDefault, and PushTechnology.ClientInterface.Client.Features.TopicTreeHandlerDefault.

---

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

• UCIStack/Client/Features/ITopicTreeHandler.cs