PushTechnology.ClientInterface.Client.Topics.Details.TopicSpecificationProperty Class Reference

Contains all valid ITopicSpecification property keys. More...

Static Public Attributes
static readonly string	PublishValuesOnly = "PUBLISH_VALUES_ONLY"
	Key of topic property indicating whether a topic should publish only values. More...
static readonly string	ValidateValues = "VALIDATE_VALUES"
	Key of the topic property indicating whether a topic should validate inbound values. More...

Detailed Description

Contains all valid ITopicSpecification property keys.

Member Data Documentation

readonly string PushTechnology.ClientInterface.Client.Topics.Details.TopicSpecificationProperty.PublishValuesOnly = "PUBLISH_VALUES_ONLY"

static

Key of topic property indicating whether a topic should publish only values.

By default, topics with a topic IDataType{TValue} that supports deltas will publish a delta when doing so is more efficient than publishing the value. Setting this property to 'true' disables this behavior so that deltas are never published. This would result in more data being transmitted, but would allow the client to only have to process values and not deltas.

If this property is not set (or set to something other than 'true') and a topic publishes deltas, clients would need to use value streams to process the topics. If a client uses topic streams, it would need to process the deltas manually.

If the client is using value streams to process the topics, it is not recommended to set this property as it will only lead to higher bandwidth usage.

For topic data types that do not have delta support this value is irrelevant as only values would ever be published anyway.

readonly string PushTechnology.ClientInterface.Client.Topics.Details.TopicSpecificationProperty.ValidateValues = "VALIDATE_VALUES"

static

Key of the topic property indicating whether a topic should validate inbound values.

By default, the server does not validate received values before sending them on to clients. Invalid or corrupt values will be stored in the topic and passed on to clients. If this property is set to 'true', the server will perform additional validation on values to check that it is a valid instance of the data type, and if it is not then it will return an error to the updater and not update the topic.

If this value is not set (or set to something other than 'true'), no server validation of inbound values is performed. This is the recommended setting as there is a performance overhead to validation and a client using a value updater could not send invalid values anyway.

---

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

• UCIStack/Client/Topics/Details/TopicSpecificationProperty.cs