PushTechnology.ClientInterface.Client.Callbacks.ITopicTreeHandler Interface Reference

Common interface for callback handlers that establish a server side control presence for the client session at a particular branch of the topic tree. More...

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

Public Member Functions
void	OnRegistered (string topicPath, IRegistration registration)
	Called when the handler has been successfully registered with the server. More...
void	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 close. More...
void	OnError (string topicPath, ErrorReason errorReason)
	Notification of a contextual error related to this handler. This is analogous to an exception being raised. Situations in which OnError is called include the session being closed before the handler is registered, a communication timeout, or a problem with the provided parameters. No further calls will be made to this handler. More...

Detailed Description

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

Member Function Documentation

void PushTechnology.ClientInterface.Client.Callbacks.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 close.

No further calls will be made for the handler.

Parameters

topicPath

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

Implemented in PushTechnology.ClientInterface.Client.Callbacks.DefaultTopicTreeHandler.

void PushTechnology.ClientInterface.Client.Callbacks.ITopicTreeHandler.OnError	(	string	topicPath,
		ErrorReason	errorReason
	)

Notification of a contextual error related to this handler. This is analogous to an exception being raised. Situations in which OnError is called include the session being closed before the handler is registered, a communication timeout, or a problem with the provided parameters. No further calls will be made to this handler.

Parameters

topicPath	the branch of the topic tree for which the handler was registered
errorReason	a value representing the error; this can be one of constants defined in ErrorReason, or a feature-specific reason

Implemented in PushTechnology.ClientInterface.Client.Callbacks.DefaultTopicTreeHandler, and PushTechnology.ClientInterface.Client.Features.Control.Topics.TopicControlEventListenerDefault.

void PushTechnology.ClientInterface.Client.Callbacks.ITopicTreeHandler.OnRegistered	(	string	topicPath,
		IRegistration	registration
	)

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, registration 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
registration	allows the handler to be closed

Implemented in PushTechnology.ClientInterface.Client.Callbacks.DefaultTopicTreeHandler, and PushTechnology.ClientInterface.Client.Features.Control.Topics.TopicControlEventListenerDefault.

---

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

• UCIStack/Client/Callbacks/TopicTreeHandler.cs