PushTechnology.ClientInterface.Client.Features.Control.Topics.TopicControlEventListenerDefault Class Reference

Abstract implementation of ITopicControlTopicEventListener, may be extended to provide the ITopicControlTopicEventListener.OnHasSubscribers and ITopicControlTopicEventListener.OnNoSubscribers methods. More...

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

Public Member Functions
virtual void	OnRegistered (string topicPath, IRegistration registration)
	Called when the handler has been successfully registered with the server. More...
virtual 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...
virtual void	OnHasSubscribers (string topicPath)
	A topic that previously had no subscribers now has at least one. More...
virtual void	OnNoSubscribers (string topicPath)
	A topic that previously had some subscribers now has none. More...
Public Member Functions inherited from PushTechnology.ClientInterface.Client.Features.TopicTreeHandlerDefault
virtual void	OnActive (string topicPath, IRegisteredHandler registeredHandler)
	Called when the handler has been registered at the server and is now active. More...
virtual void	OnClose (string topicPath)
	Called if the handler is closed. More...
Public Member Functions inherited from PushTechnology.ClientInterface.Client.Callbacks.ITopicTreeHandler
void	OnClose (string topicPath)
	Called if the handler is closed. More...

Detailed Description

Abstract implementation of ITopicControlTopicEventListener, may be extended to provide the ITopicControlTopicEventListener.OnHasSubscribers and ITopicControlTopicEventListener.OnNoSubscribers methods.

Member Function Documentation

virtual void PushTechnology.ClientInterface.Client.Features.Control.Topics.TopicControlEventListenerDefault.OnError ( string  topicPath, ErrorReason  errorReason  )

virtual

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

Implements PushTechnology.ClientInterface.Client.Callbacks.ITopicTreeHandler.

virtual void PushTechnology.ClientInterface.Client.Features.Control.Topics.TopicControlEventListenerDefault.OnHasSubscribers ( string  topicPath )

virtual

A topic that previously had no subscribers now has at least one.

Parameters

topicPath

Implements PushTechnology.ClientInterface.Client.Features.Control.Topics.ITopicControlTopicEventListener.

virtual void PushTechnology.ClientInterface.Client.Features.Control.Topics.TopicControlEventListenerDefault.OnNoSubscribers ( string  topicPath )

virtual

A topic that previously had some subscribers now has none.

Parameters

topicPath

Implements PushTechnology.ClientInterface.Client.Features.Control.Topics.ITopicControlTopicEventListener.

virtual void PushTechnology.ClientInterface.Client.Features.Control.Topics.TopicControlEventListenerDefault.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.

Parameters

topicPath	the path that the handler is active for
registration	allows the handler to be closed

Implements PushTechnology.ClientInterface.Client.Callbacks.ITopicTreeHandler.

---

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

• LegacyModule/Client/Features/Control/Topics/TopicControlEventListenerDefault.cs