PushTechnology.ClientInterface.Client.Callbacks.DefaultTopicTreeHandler Class Reference

The default ITopicTreeHandler implementation. More...

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

Public Member Functions
virtual void	OnRegistered (string topicPath, IRegistration registration)
	Called when the handler has been successfully registered with the server. More...
virtual void	OnClose (string topicPath)
	Called if the handler is closed. More...
virtual void	OnError (string topicPath, ErrorReason errorReason)
	Notification of a contextual error related to this handler. More...

Detailed Description

The default ITopicTreeHandler implementation.

This simply logs OnRegistered and OnClose calls at 'debug' level and OnError calls at 'warn' level. This can be overridden to perform some more specific action.

Member Function Documentation

virtual void PushTechnology.ClientInterface.Client.Callbacks.DefaultTopicTreeHandler.OnClose ( string  topicPath )

virtual

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

No further calls will be made for the handler.

Parameters

topicPath

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

Implements PushTechnology.ClientInterface.Client.Callbacks.ITopicTreeHandler.

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

virtual

Notification of a contextual error related to this handler.

Situations in which this method 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	The reason for the error.

Implements PushTechnology.ClientInterface.Client.Callbacks.ITopicTreeHandler.

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

virtual

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

Parameters

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

Implements PushTechnology.ClientInterface.Client.Callbacks.ITopicTreeHandler.

---

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

• Client.Public/Callbacks/ITopicTreeHandler.cs