 |
Diffusion .NET Client Library
6.1.5
|
|
Diffusion .NET Client Library
6.1.5
|
Represents a source of updates which may be registered in order to update parts of the topic tree. More...
Public Member Functions | |
| void | OnActive (string topicPath, ITopicUpdater updater) |
| 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. More... | |
| void | OnStandby (string topicPath) |
| Notifies that this source is not currently allowed to provide topic updates for the specified topic path. More... | |
 Public Member Functions inherited from PushTechnology.ClientInterface.Client.Callbacks.ITopicTreeHandler | |
| 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. More... | |
| void | OnError (string topicPath, ErrorReason errorReason) |
| Notification of a contextual error related to this handler. More... | |
Represents a source of updates which may be registered in order to update parts of the topic tree.
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 via the OnRegistered 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
| void PushTechnology.ClientInterface.Client.Features.Control.Topics.ITopicUpdateSource.OnActive | ( | string | topicPath, |
| ITopicUpdater | updater | ||
| ) |
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.
| topicPath | The registration path. |
| 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 ITopicUpdater.ValueUpdater{TValue} is used to obtain an updater specific to certain topic types. |
Implemented in PushTechnology.ClientInterface.Client.Features.Control.Topics.TopicUpdateSourceDefault.
| void PushTechnology.ClientInterface.Client.Features.Control.Topics.ITopicUpdateSource.OnStandby | ( | string | topicPath | ) |
Notifies 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 path will no longer be valid for use.
| topicPath | The registration path. |
Implemented in PushTechnology.ClientInterface.Client.Features.Control.Topics.TopicUpdateSourceDefault.
1.8.5 
