Diffusion .NET Client Library  6.1.5
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
Properties | List of all members
PushTechnology.ClientInterface.Client.Topics.ITopicDetails Interface Reference

Base interface for topic details of all TopicType types. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Topics.ITopicDetails:
PushTechnology.ClientInterface.Client.Topics.IRecordTopicDetails PushTechnology.ClientInterface.Client.Topics.ISingleValueTopicDetails PushTechnology.ClientInterface.Client.Topics.ISlaveTopicDetails PushTechnology.ClientInterface.Client.Topics.IStatelessTopicDetails PushTechnology.ClientInterface.TopicDetails.Details.IRoutingTopicDetails PushTechnology.ClientInterface.TopicDetails.Details.IUniversalTopicDetails

Properties

TopicDetailsLevel Level [get]
 Returns the level of detail available. More...
 
TopicType Type [get]
 Returns the topic type. More...
 
ITopicDetailsSchema Schema [get]
 Returns the topic schema. More...
 
ITopicDetailsAttributes Attributes [get]
 Returns the topic attributes. More...
 

Detailed Description

Base interface for topic details of all TopicType types.

Topic details fully describe a topic and are made up of three parts:

  1. The Topic Type This describes the type of topic which may define a data topic and the type of data it manages, or a functional topic.
  2. The Topic Schema This describes the layout of the data within a data topic. A schema is present for all topic types although some do not describe any detail.
  3. The Topic Attributes Every topic has a set of attributes which describes aspects of its behaviour. In most cases the default attribute settings would suffice but attributes may be tailored as required. All topic types have some common attributes and many topic types also have attributes specific to the type.

Topic details may be defined using a ITopicDetailsBuilder{TB,TD} created using the ITopicControl feature (see ITopicControl.CreateDetailsBuilder{TB} and used to create topics.

Alternatively, where only simple details are required there is no need to use a builder as a simple details object for a type can be created using ITopicControl.NewDetails(TopicType).

Where many topics are to have the same definition then the same topic detail can (and indeed should) be used to create many topics.

Topic details are also used to provide details of existing topics to clients. In this case schema and/or attributes may not be present in the details if that level of details was not requested.

Subtypes of this type exist for all TopicType types.

Property Documentation

ITopicDetailsAttributes PushTechnology.ClientInterface.Client.Topics.ITopicDetails.Attributes
get

Returns the topic attributes.

TopicDetailsLevel PushTechnology.ClientInterface.Client.Topics.ITopicDetails.Level
get

Returns the level of detail available.

ITopicDetailsSchema PushTechnology.ClientInterface.Client.Topics.ITopicDetails.Schema
get

Returns the topic schema.

The schema is used to define the layout of the topic content.

TopicType PushTechnology.ClientInterface.Client.Topics.ITopicDetails.Type
get

Returns the topic type.

The type of topic defines its basic behaviour.

This is determined by the subtype.

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