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

Default ITopicUpdateSource implementation. More...

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

Public Member Functions
virtual void	OnActive (string topicPath, ITopicUpdater updater)
	State notification that this source is now active for the specified topic path, and is therefore in a valid state to send updates on topics at or below the registered topic path. More...
virtual void	OnStandby (string topicPath)
	Notification that this source is not currently allowed to provide topic updates for the specified topic path. This indicates that another update source is currently active for the given topic path. More...
Public Member Functions inherited from PushTechnology.ClientInterface.Client.Callbacks.DefaultTopicTreeHandler
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. 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...
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...

Detailed Description

Default ITopicUpdateSource implementation.

Member Function Documentation

virtual void PushTechnology.ClientInterface.Client.Features.Control.Topics.TopicUpdateSourceDefault.OnActive ( string  topicPath, ITopicUpdater  updater  )

virtual

State notification that this source is now active for the specified topic path, and is therefore in a valid state to send updates on topics at or below the registered topic path.

Parameters

topicPath	The registration path.
updater	An updater that may be used to update topics at or below the registered path.

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

virtual void PushTechnology.ClientInterface.Client.Features.Control.Topics.TopicUpdateSourceDefault.OnStandby ( string  topicPath )

virtual

Notification that this source is not currently allowed to provide topic updates for the specified topic path. This indicates that another update source is currently active for the given topic path.

Server policy will dictate when this update source is set to be active.

If this update source was previously in an active state, any updater instances for this topic will no longer be valid for use.

Parameters

topicPath

The registration path.

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

---

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

• UCIStack/Client/Features/Control/Topics/TopicUpdateSourceDefault.cs