6 PubSub Communication Parameters ToC Previous Next

6.2 Common Configuration Parameters ToC Previous Next

6.2.6 PubSubConnection Parameters ToC Previous Next

6.2.6.1 PublisherId ToC

The PublisherId is a unique identifier for a Publisher within a Message Oriented Middleware. It can be included in sent NetworkMessage for identification or filtering. The value of the PublisherId is typically shared between PubSubConnections but the assignment of the PublisherId is vendor specific.

The PublisherId parameter is only relevant for the Publisher functionality inside a PubSubConnection. The filter setting on the Subscriber side is contained in the DataSetReader parameters.

Valid DataTypes are UInteger and String.

6.2.6.2 TransportProfileUri ToC

The TransportProfileUri parameter with DataType String indicates the transport protocol mapping and the message mapping used.

The possible TransportProfileUri values are defined as URI of the transport protocols defined as PubSub transport Facet in Part 7.

6.2.6.3 Address ToC

The Address parameter contains the network address information for the communication middleware. The different Structure DataTypes used to represent the Address are defined in 6.2.6.5.3.

6.2.6.4 ConnectionProperties ToC

The ConnectionProperties parameter is an array of DataType KeyValuePair specifies additional properties for the configured connection. The KeyValuePair type is defined in Part 5 and consists of a QualifiedName and a value of BaseDataType.

The mapping of the namespace, name, and value to concrete functionality may be defined by transport protocol mappings, future versions of this specification or vendor specific extensions.

6.2.6.5 PubSubConnection Structure ToC Model

6.2.6.5.1 PubSubConnectionDataType ToC Model

This Structure DataType is used to represent the configuration parameters for PubSubConnections. The PubSubConnectionDataType is formally defined in Table 26.

Table 26 – PubSubConnectionDataType Structure

Name Type Description
PubSubConnectionDataType Structure  
 name String The name of the PubSubConnection.
 enabled Boolean The enabled state of the PubSubConnection.
 publisherId BaseDataType Defined in 6.2.6.1.
 transportProfileUri String Defined in 6.2.6.2.
 address NetworkAddressDataType Defined in 6.2.6.3. The NetworkAddressDataType is defined in 6.2.6.5.3.
 connectionProperties KeyValuePair[] Defined in 6.2.6.4.
 transportSettings ConnectionTransportDataType Transport mapping specific PubSubConnection parameters. The abstract base type is defined in 6.2.6.5.2. The concrete subtypes are defined in the sections for transport mapping specific parameters.
 writerGroups WriterGroupDataType[] The WriterGroups contained in the PubSubConnection. The WriterGroup is defined in 6.2.5.
 readerGroups ReaderGroupDataType[] The ReaderGroups contained in the PubSubConnection. The ReaderGroup is defined in 6.2.7.

6.2.6.5.2 ConnectionTransportDataType ToC Model

This Structure DataType is an abstract base type for transport mapping specific PubSubConnection parameters. The abstract DataType does not define fields.

The ConnectionTransportDataType Structure representation in the AddressSpace is defined in Table 27.

Table 27 – ConnectionTransportDataType Definition

Attributes Value    
BrowseName ConnectionTransportDataType    
IsAbstract True    
References NodeClass BrowseName IsAbstract
Subtype of Structure defined in Part 5.      

6.2.6.5.3 NetworkAddressDataType ToC Model

Subtypes of this abstract Structure DataType are used to represent network address information. The NetworkAddressDataType is formally defined in Table 28.

Table 28 – NetworkAddressDataType Structure

Name Type Description
NetworkAddressDataType Structure  
 networkInterface String The name of the network interface used for the communication relation.

The NetworkAddressDataType Structure representation in the AddressSpace is defined in Table 29.

Table 29 – NetworkAddressDataType Definition

Attributes Value      
BrowseName NetworkAddressDataType      
IsAbstract True      
References NodeClass BrowseName IsAbstract Description
Subtype of Structure defined in Part 5.        
HasSubtype DataType NetworkAddressUrlDataType False Defined in 6.2.6.5.4.

6.2.6.5.4 NetworkAddressUrlDataType ToC Model

This Structure DataType is used to represent network address information in the form of an URL String. The NetworkAddressUrlDataType is formally defined in Table 30.

Table 30 – NetworkAddressUrlDataType Structure

Name Type Description
NetworkAddressUrlDataType Structure  
 url String The address string for the communication relation in the form on an URL String.

The NetworkAddressUrlDataType Structure representation in the AddressSpace is defined in Table 31.

Table 31 – NetworkAddressUrlDataType Definition

Attributes Value    
BrowseName NetworkAddressUrlDataType    
IsAbstract False    
References NodeClass BrowseName IsAbstract
Subtype of NetworkAddressDataType defined in 6.2.6.5.3.      

Previous Next