Diffusion .NET Classic API - Core and Common  5.9.4
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty Class Reference

Specifies topic property keys that may be used in topic definitions (TopicDefinition). More...

Static Public Member Functions

static TopicProperty FromKey (string key)
 Returns a TopicProperty from its key representation. More...
 

Static Public Attributes

static readonly TopicProperty Lockable = new TopicProperty( "LOC" )
 Indicates whether the topic is lockable. More...
 
static readonly TopicProperty Attachment = new TopicProperty( "ATO" )
 This property defines the topic attachment. More...
 
static readonly TopicProperty AttachmentClass = new TopicProperty( "ATC" )
 This property defines the topic attachment class. More...
 
static readonly TopicProperty Reference = new TopicProperty( "REF" )
 This specifies the topic reference. More...
 
static readonly TopicProperty SubscriptionHandler = new TopicProperty( "SHO" )
 Specifies a subsription handler. More...
 
static readonly TopicProperty SubscriptionHandlerClass = new TopicProperty( "SHC" )
 Specifies a subscription handler. More...
 
static readonly TopicProperty LoadMessageCapacity = new TopicProperty( "LMC" )
 Specifies the default load message capacity. More...
 
static readonly TopicProperty DeltaMessageCapacity = new TopicProperty( "DMC" )
 Specifies the default delta message capacity. More...
 
static readonly TopicProperty IntrospectionMask = new TopicProperty( "ISM" )
 Introspection mask. More...
 
static readonly TopicProperty LockTimeout = new TopicProperty( "LTO" )
 Lock timeout. More...
 
static readonly TopicProperty TidyOnUnsubcribe = new TopicProperty( "TOU" )
 Tidy on unsubscribe. More...
 
static readonly TopicProperty DomainTopicName = new TopicProperty( "DTN" )
 Domain topic name. More...
 
static readonly TopicProperty LoadEncoding = new TopicProperty( "LEN" )
 Load encoding. More...
 
static readonly TopicProperty DeltaEncoding = new TopicProperty( "DEN" )
 Delta encoding. More...
 
static readonly TopicProperty DataInitialiser = new TopicProperty( "DIO" )
 Specifies a topic data initialiser. More...
 
static readonly TopicProperty DataInitialiserClass = new TopicProperty( "DIC" )
 Specifies a topic data initialiser class. More...
 
static readonly TopicProperty LoadHeaders = new TopicProperty( "LDH" )
 Specifies headers to be associated with load messages. More...
 
static readonly TopicProperty LoadAckRequired = new TopicProperty( "LAR" )
 Specifies that load messages require acknowledgement. More...
 
static readonly TopicProperty DeltaAckRequired = new TopicProperty( "DAR" )
 Specifies that delta messages require acknowledgement. More...
 
static readonly TopicProperty PagedComparator = new TopicProperty( "PX_CO" )
 Specifies a paged topic comparator. More...
 
static readonly TopicProperty PagedComparatorClass = new TopicProperty( "PX_CC" )
 Specifies a paged topic comparator class. More...
 
static readonly TopicProperty PagedDuplicatesPolicy = new TopicProperty( "PX_DP" )
 Specifies paged topic duplicates policy. More...
 
static readonly TopicProperty ProtocolBufferClass = new TopicProperty( "G_PC" )
 Specifies a Protocol Buffer 'proto' class name. More...
 
static readonly TopicProperty ProtocolBufferName = new TopicProperty( "G_MN" )
 Specifies a Protocol Buffer message name. More...
 
static readonly TopicProperty ProtocolBufferUpdateMode = new TopicProperty( "G_UM" )
 Specifies the Protocol Buffer topic data update mode. More...
 
static readonly TopicProperty ProtocolBufferDeletionValue = new TopicProperty( "G_DV" )
 Specifies the Protocol Buffer topic data deletion value. More...
 
static readonly TopicProperty CustomHandler = new TopicProperty( "U_HO" )
 Specifies a custom topic handler. More...
 
static readonly TopicProperty CustomHandlerClass = new TopicProperty( "U_HC" )
 Specifies a custom topic handler. More...
 
static readonly TopicProperty RecordEmptyFieldValue = new TopicProperty( "R_EFV" )
 Specifies a value to use to represent empty fields. More...
 
static readonly TopicProperty ServiceType = new TopicProperty( "SV_TY" )
 Specifies service type. More...
 
static readonly TopicProperty ServiceHandler = new TopicProperty( "SV_HO" )
 Specifies a Service handler. More...
 
static readonly TopicProperty ServiceHandlerClass = new TopicProperty( "SV_HC" )
 Specifies a Service handler. More...
 
static readonly TopicProperty ServiceTimeout = new TopicProperty( "SV_TO" )
 Specifies a service request timeout. More...
 
static readonly TopicProperty ServiceTargetTopic = new TopicProperty( "SV_TT" )
 Specifies a service target topic name. More...
 
static readonly TopicProperty ServiceHeaders = new TopicProperty( "SV_HD" )
 Specifies service header options. More...
 
static readonly TopicProperty SlaveMasterTopic = new TopicProperty( "SD_MT" )
 Specifies the master topic name for a slave topic. More...
 
static readonly TopicProperty RoutingHandler = new TopicProperty( "RO_HO" )
 Specifies a routing topic subscription handler. More...
 
static readonly TopicProperty RoutingHandlerClass = new TopicProperty( "RO_HC" )
 Specifies a routing topic subscription handler. More...
 
static readonly TopicProperty NotifyMetadataCaching = new TopicProperty( "TN_MC" )
 Specifies whether a topic notify topic supports metadata caching. More...
 
static readonly TopicProperty NotifyAllTopics = new TopicProperty( "TN_NA" )
 Specifies whether a topic notify topic notifies all topics, or only those owned by the same Publisher as the notifier. More...
 
static readonly TopicProperty PublishValuesOnly = new TopicProperty( TopicSpecificationProperty.PublishValuesOnly )
 Specifies whether a topic should publish only values. More...
 
static readonly TopicProperty ValidateValues = new TopicProperty( TopicSpecificationProperty.ValidateValues )
 Specifies whether a topic should validate inbound values. More...
 

Properties

string Key [get, set]
 Get/set the property key value. More...
 

Detailed Description

Specifies topic property keys that may be used in topic definitions (TopicDefinition).

Member Function Documentation

static TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.FromKey ( string  key)
static

Returns a TopicProperty from its key representation.

Parameters
keyThe property key in either lower or upper case.
Returns
The property, or null if not recognised.

Member Data Documentation

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.Attachment = new TopicProperty( "ATO" )
static

This property defines the topic attachment.

This is an optional object to be attached to the topic.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.AttachmentClass = new TopicProperty( "ATC" )
static

This property defines the topic attachment class.

This is an optional string property specifying a full class name.

If specified then the 'no arguments' constructor of the class will be used to create an instance of the class and attach it to the topic.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.CustomHandler = new TopicProperty( "U_HO" )
static

Specifies a custom topic handler.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.CustomHandlerClass = new TopicProperty( "U_HC" )
static

Specifies a custom topic handler.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.DataInitialiser = new TopicProperty( "DIO" )
static

Specifies a topic data initialiser.

This is used with topics of type PublishingTopicData but would be ignored for all other types.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.DataInitialiserClass = new TopicProperty( "DIC" )
static

Specifies a topic data initialiser class.

This is used with topics of type PublishingTopicData, but would be ignored for all other types.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.DeltaAckRequired = new TopicProperty( "DAR" )
static

Specifies that delta messages require acknowledgement.

This is an optional boolean property that only applies to topics that have data of type PublishingTopicData.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.DeltaEncoding = new TopicProperty( "DEN" )
static

Delta encoding.

This is an optional byte property.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.DeltaMessageCapacity = new TopicProperty( "DMC" )
static

Specifies the default delta message capacity.

This is an optional integer property.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.DomainTopicName = new TopicProperty( "DTN" )
static

Domain topic name.

This indicates that the topic is a subdomain of the specified topic, which is a Remote Control Service topic of type TopicDataType.REMOTE_SERVICE.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.IntrospectionMask = new TopicProperty( "ISM" )
static

Introspection mask.

This is an optional byte property.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.LoadAckRequired = new TopicProperty( "LAR" )
static

Specifies that load messages require acknowledgement.

This is an optional boolean property that only applies to topics that have data of type PublishingTopicData.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.LoadEncoding = new TopicProperty( "LEN" )
static

Load encoding.

This is an optional byte property.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.LoadHeaders = new TopicProperty( "LDH" )
static

Specifies headers to be associated with load messages.

This is an optional string property that only applies to topics that have data of type PublishingTopicData.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.LoadMessageCapacity = new TopicProperty( "LMC" )
static

Specifies the default load message capacity.

This is an optional integer property.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.Lockable = new TopicProperty( "LOC" )
static

Indicates whether the topic is lockable.

This is an optional boolean property.

This only applies to a topic of type TopicDataType.NONE and if not specified, then 'true' would be assumed.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.LockTimeout = new TopicProperty( "LTO" )
static

Lock timeout.

This is an optional long property.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.NotifyAllTopics = new TopicProperty( "TN_NA" )
static

Specifies whether a topic notify topic notifies all topics, or only those owned by the same Publisher as the notifier.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.NotifyMetadataCaching = new TopicProperty( "TN_MC" )
static

Specifies whether a topic notify topic supports metadata caching.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.PagedComparator = new TopicProperty( "PX_CO" )
static

Specifies a paged topic comparator.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.PagedComparatorClass = new TopicProperty( "PX_CC" )
static

Specifies a paged topic comparator class.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.PagedDuplicatesPolicy = new TopicProperty( "PX_DP" )
static

Specifies paged topic duplicates policy.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.ProtocolBufferClass = new TopicProperty( "G_PC" )
static

Specifies a Protocol Buffer 'proto' class name.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.ProtocolBufferDeletionValue = new TopicProperty( "G_DV" )
static

Specifies the Protocol Buffer topic data deletion value.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.ProtocolBufferName = new TopicProperty( "G_MN" )
static

Specifies a Protocol Buffer message name.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.ProtocolBufferUpdateMode = new TopicProperty( "G_UM" )
static

Specifies the Protocol Buffer topic data update mode.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.PublishValuesOnly = new TopicProperty( TopicSpecificationProperty.PublishValuesOnly )
static

Specifies whether a topic should publish only values.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.RecordEmptyFieldValue = new TopicProperty( "R_EFV" )
static

Specifies a value to use to represent empty fields.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.Reference = new TopicProperty( "REF" )
static

This specifies the topic reference.

This is an optional string property.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.RoutingHandler = new TopicProperty( "RO_HO" )
static

Specifies a routing topic subscription handler.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.RoutingHandlerClass = new TopicProperty( "RO_HC" )
static

Specifies a routing topic subscription handler.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.ServiceHandler = new TopicProperty( "SV_HO" )
static

Specifies a Service handler.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.ServiceHandlerClass = new TopicProperty( "SV_HC" )
static

Specifies a Service handler.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.ServiceHeaders = new TopicProperty( "SV_HD" )
static

Specifies service header options.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.ServiceTargetTopic = new TopicProperty( "SV_TT" )
static

Specifies a service target topic name.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.ServiceTimeout = new TopicProperty( "SV_TO" )
static

Specifies a service request timeout.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.ServiceType = new TopicProperty( "SV_TY" )
static

Specifies service type.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.SlaveMasterTopic = new TopicProperty( "SD_MT" )
static

Specifies the master topic name for a slave topic.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.SubscriptionHandler = new TopicProperty( "SHO" )
static

Specifies a subsription handler.

This is an optional object property where the object must be of type TopicSubscriptionHandler.

If specified, then the subscription handler will be attached to the topic on creation.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.SubscriptionHandlerClass = new TopicProperty( "SHC" )
static

Specifies a subscription handler.

This is an optional string property specifying the full name of a loadable class of type TopicSubscriptionHandler.

If specified, then the class must have a 'no arguments' constructor which will be used to create and associate the handler object when the topic is created.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.TidyOnUnsubcribe = new TopicProperty( "TOU" )
static

Tidy on unsubscribe.

This is an optional boolean property.

readonly TopicProperty PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.ValidateValues = new TopicProperty( TopicSpecificationProperty.ValidateValues )
static

Specifies whether a topic should validate inbound values.

Property Documentation

string PushTechnology.DiffusionCore.Messaging.Topic.TopicProperty.Key
getset

Get/set the property key value.