Diffusion .NET API  5.9.24
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events Pages
Public Types | Static Public Attributes | List of all members
PushTechnology.ClientInterface.Client.Topics.Update.UpdateType Class Reference

Indicates the type of update. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Topics.Update.UpdateType:

Public Types

enum  UpdateTypeEnum {
  UpdateTypeEnum.CONTENT, UpdateTypeEnum.PAGED_RECORD_ORDERED, UpdateTypeEnum.PAGED_STRING_ORDERED, UpdateTypeEnum.PAGED_RECORD_UNORDERED,
  UpdateTypeEnum.PAGED_STRING_UNORDERED
}
 Enumerations for an update type. More...
 

Static Public Attributes

static readonly UpdateType CONTENT
 Unspecified content that can be used to update a snapshot/delta-type topic. More...
 
static readonly UpdateType PAGED_RECORD_ORDERED
 An update to a TopicType.PAGED_RECORD topic that has ordered lines of data. More...
 
static readonly UpdateType PAGED_STRING_ORDERED
 An update to a TopicType.PAGED_STRING topic that has ordered lines of data. More...
 
static readonly UpdateType PAGED_RECORD_UNORDERED
 An update to a TopicType.PAGED_RECORD topic that has unordered lines of data. More...
 
static readonly UpdateType PAGED_STRING_UNORDERED
 An update to a TopicType.PAGED_STRING topic that has unordered lines of data. More...
 

Detailed Description

Indicates the type of update.

Member Enumeration Documentation

enum PushTechnology.ClientInterface.Client.Topics.Update.UpdateType.UpdateTypeEnum

Enumerations for an update type.

Enumerator
CONTENT 

Unspecified content that can be used to update a snapshot/delta-type topic.

The effect of such updates at the server will depend upon the topic type as follows:

  1. TopicType.Stateful topics.

The content must be formatted in a way that is suitable for the topic type and will be applied according to the UpdateAction.

For a UpdateAction.MATCH action then the content should be a full representation of the topic state and will be compared with the current state and deltas of change will then be published to all subscribed clients.

For a UpdateAction.REFRESH action the whole topic state will be replaced by the supplied content and a snapshot published to all subscribed clients.

For a UpdateAction.UPDATE action the content will be treated as a partial update (an input delta) and the state of any missing fields will remain as within the current state. This only applies to some topic types. For a TopicType.SINGLE_VALUE topic this would have the same effect as a match action.

  1. TopicType.DELEGATED or TopicType.STATELESS topics.

The content will be relayed 'as is' to all clients that are subscribed to the topic. A UpdateAction.MATCH action would be relayed as a snapshot otherwise the content is relayed as a delta.

  1. Other topic types (i.e. TopicType.Functional topics.

An update should not be applied to such topic types and an attempt to do so will result in an update error.

PAGED_RECORD_ORDERED 

An update to a TopicType.PAGED_RECORD topic that has ordered lines of data.

If an attempt is made to apply such an update to any other type of topic then an update error would occur.

Such an update will always have an action of UpdateAction.UPDATE.

PAGED_STRING_ORDERED 

An update to a TopicType.PAGED_STRING topic that has ordered lines of data.

If an attempt is made to apply such an update to any other type of topic then an update error would occur.

Such an update will always have an action of UpdateAction.UPDATE.

PAGED_RECORD_UNORDERED 

An update to a TopicType.PAGED_RECORD topic that has unordered lines of data.

If an attempt is made to apply such an update to any other type of topic then an update error would occur.

Such an update will always have an action of UpdateAction.UPDATE.

PAGED_STRING_UNORDERED 

An update to a TopicType.PAGED_STRING topic that has unordered lines of data.

If an attempt is made to apply such an update to any other type of topic then an update error would occur.

Such an update will always have an action of UpdateAction.UPDATE.

Member Data Documentation

readonly UpdateType PushTechnology.ClientInterface.Client.Topics.Update.UpdateType.CONTENT
static
Initial value:
=
new UpdateType(UpdateTypeEnum.CONTENT, 0)

Unspecified content that can be used to update a snapshot/delta-type topic.

The effect of such updates at the server will depend upon the topic type as follows:

  1. TopicType.Stateful topics.

The content must be formatted in a way that is suitable for the topic type and will be applied according to the UpdateAction.

For a UpdateAction.MATCH action then the content should be a full representation of the topic state and will be compared with the current state and deltas of change will then be published to all subscribed clients.

For a UpdateAction.REFRESH action the whole topic state will be replaced by the supplied content and a snapshot published to all subscribed clients.

For a UpdateAction.UPDATE action the content will be treated as a partial update (an input delta) and the state of any missing fields will remain as within the current state. This only applies to some topic types. For a TopicType.SINGLE_VALUE topic this would have the same effect as a match action.

  1. TopicType.DELEGATED or TopicType.STATELESS topics.

The content will be relayed 'as is' to all clients that are subscribed to the topic. A UpdateAction.MATCH action would be relayed as a snapshot otherwise the content is relayed as a delta.

  1. Other topic types (i.e. TopicType.Functional topics.

An update should not be applied to such topic types and an attempt to do so will result in an update error.

readonly UpdateType PushTechnology.ClientInterface.Client.Topics.Update.UpdateType.PAGED_RECORD_ORDERED
static
Initial value:
=
new UpdateType(UpdateTypeEnum.PAGED_RECORD_ORDERED, 1)

An update to a TopicType.PAGED_RECORD topic that has ordered lines of data.

If an attempt is made to apply such an update to any other type of topic then an update error would occur.

Such an update will always have an action of UpdateAction.UPDATE.

readonly UpdateType PushTechnology.ClientInterface.Client.Topics.Update.UpdateType.PAGED_RECORD_UNORDERED
static
Initial value:
=
new UpdateType(UpdateTypeEnum.PAGED_RECORD_UNORDERED, 3)

An update to a TopicType.PAGED_RECORD topic that has unordered lines of data.

If an attempt is made to apply such an update to any other type of topic then an update error would occur.

Such an update will always have an action of UpdateAction.UPDATE.

readonly UpdateType PushTechnology.ClientInterface.Client.Topics.Update.UpdateType.PAGED_STRING_ORDERED
static
Initial value:
=
new UpdateType(UpdateTypeEnum.PAGED_STRING_ORDERED, 2)

An update to a TopicType.PAGED_STRING topic that has ordered lines of data.

If an attempt is made to apply such an update to any other type of topic then an update error would occur.

Such an update will always have an action of UpdateAction.UPDATE.

readonly UpdateType PushTechnology.ClientInterface.Client.Topics.Update.UpdateType.PAGED_STRING_UNORDERED
static
Initial value:
=
new UpdateType(UpdateTypeEnum.PAGED_STRING_UNORDERED, 4)

An update to a TopicType.PAGED_STRING topic that has unordered lines of data.

If an attempt is made to apply such an update to any other type of topic then an update error would occur.

Such an update will always have an action of UpdateAction.UPDATE.

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