Interface ITopicUpdateSource
Represents a source of updates which may be registered in order to update parts of the topic tree.
Inherited Members
Namespace: PushTechnology.ClientInterface.Client.Features.Control.Topics
Assembly: Diffusion.Client.dll
Syntax
public interface ITopicUpdateSource : ITopicTreeHandler
Remarks
Deprecated: The ITopicUpdateControl feature has been replaced by the ITopicUpdate feature and will be removed in a future release. The ITopicUpdate feature provides equivalent and additional functionality, such as conditional updates.
Registering as an update source for a particular point in the topic tree allows a client to update all topics below that point in the tree. There is no need to subscribe to a topic in order to update it.
When an update source is registered it will be notified through the OnRegistered(String, IRegistration) callback. Once registered it may be in either a active state, where it can provide topic updates, or a standby state, where it is still registered but is not allowed to perform updates. An update source may switch between these states in any order, depending on server policy.
Since 5.1
Methods
OnActive(String, ITopicUpdater)
Notifies 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.
Declaration
void OnActive(string topicPath, ITopicUpdater updater)
Parameters
Type | Name | Description |
---|---|---|
String | topicPath | The registration path. |
ITopicUpdater | updater | The updater that may be used to update topics at or below the registered path. For topics that are based on IDataType<TValue>s it is recommended that ValueUpdater<TValue>() is used to obtain an updater specific to certain topic types. |
OnStandby(String)
Notifies that this source is not currently allowed to provide topic updates for the specified topic path.
Declaration
void OnStandby(string topicPath)
Parameters
Type | Name | Description |
---|---|---|
String | topicPath | The registration path. |
Remarks
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 ITopicUpdater instances for this topic path will no longer be valid for use.