PTDiffusionTopicUpdater Class Reference

Introduction

A topic updater provides methods for an update source to update topics.

An Updater can be used to send any number of updates.

If this updater was obtained by an update source, being an exclusive updater, then the topics that may be updated are determined by the topic path used when registering the update source.

See Also

PTDiffusionTopicUpdateControlFeature

Since

5.7

Inheritance diagram for PTDiffusionTopicUpdater:

Class Methods
(instancetype)	+ NS_UNAVAILABLE

Instance Methods
(instancetype)	- NS_UNAVAILABLE
(void)	- updateWithTopicPath:value:completionHandler:
(PTDiffusionBinaryValueUpdater *)	- binaryValueUpdater
(PTDiffusionJSONValueUpdater *)	- jsonValueUpdater
(PTDiffusionNumberValueUpdater *)	- int64NumberValueUpdater
(PTDiffusionNumberValueUpdater *)	- doubleFloatNumberValueUpdater
(PTDiffusionRecordV2ValueUpdater *)	- recordValueUpdater
(PTDiffusionStringValueUpdater *)	- stringValueUpdater

Method Documentation

- (PTDiffusionBinaryValueUpdater *) binaryValueUpdater

Returns an updater that can be used for the binary data type to apply value updates.

Since

6.0

Provided by category PTDiffusionTopicUpdater(PTDiffusionBinaryValueUpdater).

- (PTDiffusionNumberValueUpdater *) doubleFloatNumberValueUpdater

Returns an updater that can be used for doubleFloat data types to apply value updates.

Since

6.0

Provided by category PTDiffusionTopicUpdater(PTDiffusionNumberValueUpdater).

- (PTDiffusionNumberValueUpdater *) int64NumberValueUpdater

Returns an updater that can be used for int64 data types to apply value updates.

Since

6.0

Provided by category PTDiffusionTopicUpdater(PTDiffusionNumberValueUpdater).

- (PTDiffusionJSONValueUpdater *) jsonValueUpdater

Returns an updater that can be used for the JSON data type to apply value updates.

Since

6.0

Provided by category PTDiffusionTopicUpdater(PTDiffusionJSONValueUpdater).

- (PTDiffusionRecordV2ValueUpdater *) recordValueUpdater

Returns an updater that can be used for the record data type to apply value updates.

Since

6.0

Provided by category PTDiffusionTopicUpdater(PTDiffusionRecordV2ValueUpdater).

- (PTDiffusionStringValueUpdater *) stringValueUpdater

Returns an updater that can be used for the string data type to apply value updates.

Since

6.0

Provided by category PTDiffusionTopicUpdater(PTDiffusionStringValueUpdater).

- (void) updateWithTopicPath:		(NSString *)	topicPath
value:		(PTDiffusionBytes *)	value
completionHandler:		(NSError *_Nullable error)	completionHandler

Update the topic to the state represented by the supplied value, sending updates to subscribers if required.

Parameters

topicPath	Identifies the topic to update.
value	Value representing the new state.
completionHandler	Block to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.

Exceptions

NSInvalidArgumentException

If any of the supplied arguments are nil.

Note

The supplied value must always represent the new full topic state.

Since

5.9