PushTechnology.ClientInterface.Client.Features.ITopicTreeHandler Interface Reference

The interface for callback handlers that establish a server side control presence for the client Session.ISession at a particular branch of 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 registered at the server and is now active. More...
void	OnClose (string topicPath)
	Called if the handler is closed. More...

Detailed Description

The interface for callback handlers that establish a server side control presence for the client Session.ISession at a particular branch of the topic tree.

Member Function Documentation

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

Called when the handler has been registered at the server and is now active.

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 via IRegisteredHandler.Close().

Parameters

topicPath	The path that the handler is active for.
registeredHandler	The registration that is able to close the handler.

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

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

(

string

topicPath

)

Called if the handler is closed.

The handler will be closed if the session is closed after the handler has been registered, or if the handler is unregistered using IRegisteredHandler.Close().

Parameters

topicPath

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

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

---

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

• Client.Public/Features/ITopicTreeHandler.cs