PushTechnology.ClientInterface.Client.Features.Control.Topics.IValueUpdater< TValue > Interface Template Reference

Represents an updater that may be used to update topics of a certain type by specifying new values. More...

Inherited by PushTechnology.ClientInterface.Client.Features.Control.Topics.IDeltaUpdater< TValue, in TDelta >.

Public Member Functions
void	Update (string topicPath, TValue value, ITopicUpdaterUpdateCallback callback)
	Updates a topic to a specified value. More...
void	Update< TContext > (string topicPath, TValue value, TContext context, ITopicUpdaterUpdateContextCallback< TContext > callback)
	Updates a topic to a specified value. More...
TValue	GetCachedValue (string topicPath)
	Returns the current cached value for a given topic path. More...
void	RemoveCachedValues (string topics)
	Removes values from the value cache. More...
void	RemoveCachedValues (ITopicSelector topics)
	Removes values from the value cache. More...

Detailed Description

Represents an updater that may be used to update topics of a certain type by specifying new values.

Such an updater may be obtained from an ITopicUpdater using the ITopicUpdater.ValueUpdater{TValue}() method.

Sinze 5.8

Template Parameters

TValue

The value type which represents the IDataType of the topics that the updater can be used for.

Member Function Documentation

TValue PushTechnology.ClientInterface.Client.Features.Control.Topics.IValueUpdater< TValue >.GetCachedValue

(

string

topicPath

)

Returns the current cached value for a given topic path.

Parameters

topicPath

The topic to obtain the current value for.

Returns

The current (latest) value or null if there is no value for the given path, this might be because no value has been sent or the value has been removed from the cache

void PushTechnology.ClientInterface.Client.Features.Control.Topics.IValueUpdater< TValue >.RemoveCachedValues

(

string

topics

)

Removes values from the value cache.

If a cached value is removed, the next update for a topic will transmit the whole value to the server rather than a delta.

Parameters

topics

The selector expression or topic path indicating the topics for which entries are to be removed.

void PushTechnology.ClientInterface.Client.Features.Control.Topics.IValueUpdater< TValue >.RemoveCachedValues

(

ITopicSelector

topics

)

Removes values from the value cache.

If a cached value is removed, the next update for a topic will transmit the whole value to the server rather than a delta.

Parameters

topics

The selector indicating the topics for which entries are to be removed.

void PushTechnology.ClientInterface.Client.Features.Control.Topics.IValueUpdater< TValue >.Update	(	string	topicPath,
		TValue	value,
		ITopicUpdaterUpdateCallback	callback
	)

Updates a topic to a specified value.

For exclusive updaters, this method caches the supplied value so that subsequent calls for the same topic will be able to use the current value to calculate deltas of change to send to the server rather than having to send the whole value.

For non-exclusive updating, the complete value is always sent to the server, and the value is not cached.

Parameters

topicPath	The topic path.
value	The new value for the topic.
callback	The callback for notifications on the update request.

void PushTechnology.ClientInterface.Client.Features.Control.Topics.IValueUpdater< TValue >.Update< TContext >	(	string	topicPath,
		TValue	value,
		TContext	context,
		ITopicUpdaterUpdateContextCallback< TContext >	callback
	)

Updates a topic to a specified value.

This method will cache the supplied value so that subsequent calls for the same topic will be able to use the current value to calculate deltas of change to send to the server rather than having to send the whole value.

Template Parameters

TContext

The context type.

Parameters

topicPath	The topic path.
value	The new value for the topic.
context	The context to supply to callback notifications. May be null.
callback	The callback for notifications on the update request.

---

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

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