6 PubSub Communication Parameters ToC Previous Next

6.4 Transport Protocol Mapping Configuration Parameters ToC Previous Next

6.4.2 Broker Transport Protocol ToC Previous Next

6.4.2.1 Broker PubSubConnection ToC Model

6.4.2.1.1 ResourceUri ToC Model

The ResourceUri parameter of DataType String enables the transport implementation to look up a configured key from the corresponding KeyCredentialConfigurationType instance defined in Part 12 to use for authenticating access to the broker at the connection level or for queues configured below the connection.

If null, no authentication or anonymous authentication shall be assumed as default unless authentication settings are provided on a subordinated WriterGroup or a DataSetWriter to authenticate access to individual queues.

6.4.2.1.2 AuthenticationProfileUri ToC Model

The parameter AuthenticationProfileUri of DataType String allows the selection of the authentication protocol used by the transport implementation. This maps to the ProfileUri Property in the KeyCredentialConfigurationType instance selected through the ResourceUri and AuthenticationProfileUri Strings.

This parameter is optional. If more than one ProfileUri describing the protocol to use for authentication is configured and this value is null, the transport will choose one. If the transport cannot fine a suitable authentication mechanism in the ProfileUri array, the transport sets the State of the PubSubConnection is set to Error_3.

6.4.2.1.3 BrokerConnectionTransportDataType Structure ToC Model

This Structure DataType is used to represent the Broker specific transport mapping parameters for the PubSubConnection. It is a subtype of the ConnectionTransportDataType defined in 6.2.6.4.

The BrokerConnectionTransportDataType is formally defined in Table 68.

Table 68 – BrokerConnectionTransportDataType Structure

Name Type Description
BrokerConnectionTransportDataType Structure  
 resourceUri String Defined in 6.4.2.1.1.
 authenticationProfileUri String Defined in 6.4.2.1.2.

6.4.2.2 Broker WriterGroup ToC

6.4.2.2.1 QueueName ToC

The QueueName parameter with DataType String specifies the queue in the Broker that receives NetworkMessages sent by the Publisher. This could be the name of a queue or topic defined in the Broker.

6.4.2.2.2 ResourceUri ToC

The ResourceUri property of DataType String allows the transport implementation to look up the configured key from the corresponding KeyCredentialConfigurationType instance defined in Part 12 to use for authenticating access to the specified queue.

If this String is not null, it overrides the ResourceUri of the PubSubConnection authentication settings.

6.4.2.2.3 AuthenticationProfileUri ToC

The parameter AuthenticationProfileUri of DataType String allows the selection of the authentication protocol used by the transport implementation for authenticating access to the specified queue.

If this String is not null, it overrides the AuthenticationProfileUri of the PubSubConnection transport settings defined in 6.4.2.1.2.

6.4.2.2.4 RequestedDeliveryGuarantee ToC

The RequestedDeliveryGuarantee parameter with DataType BrokerTransportQualityOfService specifies the delivery guarantees that shall apply to all NetworkMessages published by the WriterGroup unless otherwise specified on the DataSetWriter transport settings. The DataType BrokerTransportQualityOfService is defined in 6.4.2.2.5.

The value NotSpecified_0 is not allowed on the WriterGroup. If the selected delivery guarantee cannot be applied, the WriterGroup shall set the state to Error_3.

6.4.2.2.5 BrokerTransportQualityOfService Enumeration ToC

The BrokerTransportQualityOfService Enumeration DataType is formally defined in Table 71.

The mapping of quality of service to the broker transport specific implementation is defined in 7.3.4.5 for AMQP and 7.3.5.5 for MQTT.

Table 69 – BrokerTransportQualityOfService Values

Value Description
NotSpecified_0 The value is not specified and the value of the parent object shall be used.
BestEffort_1 The transport shall make the best effort to deliver a message. Worst case this means data loss or data duplication are possible.
AtLeastOnce_2 The transport guarantees that the message shall be delivered at least once, but duplication is possible. Readers must de-duplicate based on message id or sequence number.
AtMostOnce_3 The transport guarantees that the message shall be sent once, but if it is lost it is not sent again.
ExactlyOnce_4 The transport handshake guarantees that the message shall be delivered to the broker exactly once and not more or less.

6.4.2.2.6 BrokerWriterGroupTransportDataType Structure ToC Model

This Structure DataType is used to represent the Broker specific transport mapping parameters for WriterGroups. It is a subtype of the WriterGroupTransportDataType defined in 6.2.5.6.2.

The BrokerWriterGroupTransportDataType is formally defined in Table 70.

Table 70 – BrokerWriterGroupTransportDataType Structure

Name Type Description
BrokerWriterGroupTransportDataType Structure  
 queueName String Defined in 6.4.2.2.1.
 resourceUri String Defined in 6.4.2.2.2.
 authenticationProfileUri String Defined in 6.4.2.2.3.
 requestedDeliveryGuarantee BrokerTransportQualityOfService Defined in 6.4.2.2.4.

6.4.2.3 Broker DataSetWriter ToC Model

6.4.2.3.1 QueueName ToC Model

The QueueName parameter with DataType String specifies the queue in the Broker that receives NetworkMessages sent by the Publisher for the DataSetWriter. This could be the name of a queue or topic defined in the Broker. This parameter is only valid if the NetworkMessages from the WriterGroup contain only one DataSetMessage.

If this String is not null, it overrides the QueueName of the WriterGroup transport settings.

6.4.2.3.2 ResourceUri ToC Model

The ResourceUri property of DataType String allows the transport implementation to look up the configured key from the corresponding KeyCredentialConfigurationType instance defined in Part 12 to use for authenticating access to the specified queue.

If this String is not null, it overrides the ResourceUri of the WriterGroup authentication settings.

6.4.2.3.3 AuthenticationProfileUri ToC Model

The parameter AuthenticationProfileUri of DataType String allows the selection of the authentication protocol used by the transport implementation for authenticating access to the specified queue.

If this String is not null, it overrides the AuthenticationProfileUri of the WriterGroup transport settings.

6.4.2.3.4 RequestedDeliveryGuarantee ToC Model

The RequestedDeliveryGuarantee parameter with DataType BrokerTransportQualityOfService specifies the delivery guarantees that shall apply to all messages published by the DataSetWriter. The DataType BrokerTransportQualityOfService is defined in 6.4.2.2.5.

If the value is not NotSpecified_0, it overrides the RequestedDeliveryGuarantee of the WriteGroup transport settings.

If the selected delivery guarantee cannot be applied, the DataSetWriter shall set the state to Error_3.

6.4.2.3.5 MetaDataQueueName ToC Model

For message mappings like UADP, the Subscriber needs access to the DataSetMetaData to process received DataSetMessages. The Publisher can provide the DataSetMetaData through a dedicated queue.

The parameter MetaDataQueueName with the DataType String specifies the Broker queue that receives messages with DataSetMetaData sent by the Publisher for this DataSetWriter. This could be the name of a queue or topic defined in the Broker.

6.4.2.3.6 MetaDataUpdateTime ToC Model

Specifies the interval in milliseconds with Data Type Duration at which the Publisher shall send the DataSetMetaData to the MetaDataQueueName. A value of 0 or any negative value shall be interpreted as infinite interval.

The broker transport shall publish all messages with an expiration time that is equal or greater than this value.

If the update time is infinite, a broker transport shall attempt to negotiate message retention if possible. In this case the DataSetMetaData is only sent if the ConfigurationVersion of the corresponding DataSetMetaData is changed and DataSetWriters shall try to negotiate AtLeastOnce_2 or ExactlyOnce_4 delivery guarantees with the broker for any DataSetMetaData sent to ensure meta data is available to readers.

The DataSetWriterProperties settings apply also to DataSetMetaData sent to the queue named through the MetaDataQueueName parameter.

6.4.2.3.7 BrokerDataSetWriterTransportDataType Structure ToC Model

This Structure DataType is used to represent the Broker specific transport mapping parameters for DataSetWriters. It is a subtype of the DataSetWriterTransportDataType defined in 6.2.3.5.2.

The BrokerDataSetWriterTransportDataType is formally defined in Table 71.

Table 71 – BrokerDataSetWriterTransportDataType Structure

Name Type Description
BrokerDataSetWriterTransportDataType Structure  
 queueName String Defined in 6.4.2.3.1.
 resourceUri String Defined in 6.4.2.3.2.
 authenticationProfileUri String Defined in 6.4.2.3.3.
 requestedDeliveryGuarantee BrokerTransportQualityOfService Defined in 6.4.2.3.4.
 metaDataQueueName String Defined in 6.4.2.3.5.
 metaDataUpdateTime Duration Defined in 6.4.2.3.6.

6.4.2.4 Broker DataSetReader ToC Model

6.4.2.4.1 QueueName ToC Model

The QueueName parameter with DataType String specifies the queue in the Broker where the DataSetReader can receive NetworkMessages with the DataSet of interest sent by the Publisher. This could be the name of a queue or topic defined in the Broker. This parameter is only valid if the NetworkMessages from the WriterGroup contain only one DataSetMessage.

6.4.2.4.2 ResourceUri ToC Model

The ResourceUri property of DataType String allows the transport implementation to look up the configured key from the corresponding KeyCredentialConfigurationType instance defined in Part 12 to use for authenticating access to the specified queue.

If this String is not null, it overrides the ResourceUri of the PubSubConnection authentication settings.

6.4.2.4.3 AuthenticationProfileUri ToC Model

The parameter AuthenticationProfileUri of DataType String allows the selection of the authentication protocol used by the transport implementation for authenticating access to the specified queue.

If this String is not null, it overrides the AuthenticationProfileUri of the PubSubConnection transport settings defined in 6.4.2.1.2.

6.4.2.4.4 RequestedDeliveryGuarantee ToC Model

The RequestedDeliveryGuarantee parameter with DataType BrokerTransportQualityOfService specifies the delivery guarantees the DataSetReader negotiates with the broker for all messages received. The DataType BrokerTransportQualityOfService is defined in 6.4.2.2.5.

The value NotSpecified_0 is not allowed on the DataSetReader. If the selected delivery guarantee cannot be applied, the DataSetReader shall set the state to Error_3.

6.4.2.4.5 MetaDataQueueName ToC Model

The parameter MetaDataQueueName with the DataType String specifies the Broker queue that provides messages with DataSetMetaData sent by the Publisher for the DataSet of interest. This could be the name of a queue or topic defined in the Broker.

6.4.2.4.6 BrokerDataSetReaderTransportDataType Structure ToC Model

This Structure DataType is used to represent the Broker specific transport mapping parameters for DataSetWriters. It is a subtype of the DataSetReaderTransportDataType defined in 6.2.8.11.2.

The BrokerDataSetReaderTransportDataType is formally defined in Table 72.

Table 72 – BrokerDataSetReaderTransportDataType Structure

Name Type Description
BrokerDataSetReaderTransportDataType Structure  
 queueName String Defined in 6.4.2.4.1.
 resourceUri String Defined in 6.4.2.4.2.
 authenticationProfileUri String Defined in 6.4.2.4.3.
 requestedDeliveryGuarantee BrokerTransportQualityOfService Defined in 6.4.2.4.4.
 metaDataQueueName String Defined in 6.4.2.4.5.

Previous Next