The QosDataTypes defined in the following chapters are used in the DatagramQos parameter in different datagram specific transport protocol mapping settings.
The DatagramQos contains an array of QosDataTypes. The array is null or empty if no QoS related parameters are set.
The DatagramQos parameter is always combined with a QosCategory parameter. Depending on the content of the QosCategory String, different elements need to be present within the DatagramQos array.
The specific processing of the QosCategory and DatagramQos content is described in 5.4.5.4.
Standard QosCategory values are defined in Table 103.
Table 103 – Standard QosCategory values
|
QosCategory |
Description |
|
Null or empty
|
This category indicates best-effort is used. DatagramQos shall be null or empty.
|
|
Opc.qos.cat://priority |
This category indicates priority is used. DatagramQos shall contain one element of TransmitQosPriorityDataType or ReceiveQosPriorityDataType and optionally further elements which may be omitted. |
This Structure DataType is an abstract base type for Structures with QoS related parameters. The QosDataType is formally defined in Table 104.
Table 104 – QosDataType structure
|
Name |
Type |
Description |
|
QosDataType |
Structure |
|
The QosDataType Structure representation in the AddressSpace is defined in Table 105.
Table 105 – QosDataType definition
|
Attributes |
Value |
|
BrowseName |
QosDataType |
|
IsAbstract |
True |
|
Subtype of Structure defined in OPC 10000-5. |
|
|
Conformance Units |
|
|
PubSub Parameters QoS |
|
This Structure DataType is an abstract base type for Structures with transmit QoS related parameters. The TransmitQosDataType is formally defined in Table 106.
Table 106 – TransmitQosDataType structure
|
Name |
Type |
Description |
|
TransmitQosDataType |
Structure |
|
The TransmitQosDataType Structure representation in the AddressSpace is defined in Table 107.
Table 107 – TransmitQosDataType definition
|
Attributes |
Value |
|
BrowseName |
TransmitQosDataType |
|
IsAbstract |
True |
|
Subtype of QosDataType defined in 6.4.1.1.2. |
|
|
Conformance Units |
|
|
PubSub Parameters QoS |
|
The PriorityLabel with DataType String specifies the priority of the according sender. The network stack will use the PriorityLabel to look up the priority settings for the transport protocol headers.
The priority labels defined by OPC UA should have the following form:
opc.qos.lbl://<label>
Example values are “opc.qos.lbl://low” or “opc.qos.lbl://high”. The mapping is described in 5.4.5.4.
Note: This version does not define concrete labels. The engineering process needs to provide them and also build up the PriorityMappingTable in OPC 10000-22 accordingly.
This Structure DataType is used to represent the priority lable specific transmit QoS parameters. It is a subtype of the TransmitQosDataType defined in 6.4.1.1.3.
The TransmitQosPriorityDataType is formally defined in Table 108.
Table 108 – TransmitQosPriorityDataType structure
|
Name |
Type |
Description |
|
TransmitQosPriorityDataType |
Structure |
Subtype of TransmitQosDataType defined in 6.4.1.1.3. |
|
PriorityLabel |
String |
Defined in 6.4.1.1.4.1. |
Its representation in the AddressSpace is defined in Table 109.
Table 109 – TransmitQosPriorityDataType definition
|
Attributes |
Value |
|
BrowseName |
TransmitQosPriorityDataType |
|
IsAbstract |
False |
|
Subtype of TransmitQosDataType defined in 6.4.1.1.3. |
|
|
Conformance Units |
|
|
PubSub Parameters QoS |
|
This Structure DataType is an abstract base type for Structures with receive QoS related parameters. The ReceiveQosDataType is formally defined in Table 110.
Table 110 – ReceiveQosDataType structure
|
Name |
Type |
Description |
|
ReceiveQosDataType |
Structure |
|
The ReceiveQosDataType Structure representation in the AddressSpace is defined in Table 111.
Table 111 – ReceiveQosDataType definition
|
Attributes |
Value |
|
BrowseName |
ReceiveQosDataType |
|
IsAbstract |
True |
|
Subtype of QosDataType defined in 6.4.1.1.2. |
|
|
Conformance Units |
|
|
PubSub Parameters QoS |
|
The PriorityLabel with DataType String specifies the priority of the according sender.
Futher details are defined in 6.4.1.1.4.1.
This Structure DataType is used to represent the priority lable specific receive QoS parameters. It is a subtype of the ReceiveQosDataType defined in 6.4.1.1.5.
The ReceiveQosPriorityDataType is formally defined in Table 112.
Table 112 – TransmitQosPriorityDataType structure
|
Name |
Type |
Description |
|
ReceiveQosPriorityDataType |
Structure |
Subtype of ReceiveQosDataType defined in 6.4.1.1.5. |
|
PriorityLabel |
String |
Defined in 6.4.1.1.6.1. |
Its representation in the AddressSpace is defined in Table 113.
Table 113 – ReceiveQosPriorityDataType definition
|
Attributes |
Value |
|
BrowseName |
ReceiveQosPriorityDataType |
|
IsAbstract |
False |
|
Subtype of ReceiveQosDataType defined in 6.4.1.1.5. |
|
|
Conformance Units |
|
|
PubSub Parameters QoS |
|
The DiscoveryAddress parameter contains the network address information used for the discovery probe and announcement messages. The different Structure DataTypes used to represent the Address are defined in 6.2.7.5.3.
This Structure DataType is used to represent the datagram specific transport mapping parameters for PubSubConnections. It is a subtype of the ConnectionTransportDataType defined in 6.2.7.5.2.
The DatagramConnectionTransportDataType is formally defined in Table 114.
Table 114 – DatagramConnectionTransportDataType structure
|
Name |
Type |
Description |
Allow Subtypes |
|
DatagramConnectionTransportDataType |
Structure |
Subtype of ConnectionTransportDataType defined in 6.2.6.4. |
|
|
DiscoveryAddress |
NetworkAddressDataType |
Defined in 6.4.1.2.1. The NetworkAddressDataType is defined in 6.2.7.5.3. |
True |
Its representation in the AddressSpace is defined in Table 115.
Table 115 – DatagramConnectionTransportDataType definition
|
Attributes |
Value |
|
BrowseName |
DatagramConnectionTransportDataType |
|
IsAbstract |
False |
|
Subtype of ConnectionTransportDataType defined in 6.2.7.5.2. |
|
|
Conformance Units |
|
|
PubSub Parameters Datagram |
|
The DiscoveryAnnounceRate with DataType UInt32 defines the interval in seconds used for cyclic sending of discovery announcement messages related to this connection.
The default value is 0 and defines that discovery announcement messages are only sent as response to discovery probe messages.
The DiscoveryMaxMessageSize with DataType UInt32 indicates the maximum size in bytes for NetworkMessages created for discovery. It refers to the size of the complete NetworkMessage including padding and signature without any additional headers added by the transport protocol mapping. If the size of a NetworkMessage exceeds the DiscoveryMaxMessageSize, the behaviour depends on the message mapping.
The default value is 0 and defines that the default size for the transport protocol ist used. The default size is defined for the transport protocol mappings in 7.3.
NOTE The value for the DiscoveryMaxMessageSize should be configured in a way that ensures that NetworkMessages together with additional headers added by the transport protocol are still smaller than or equal than the transport protocol MTU.
Selects the general category of QoS the PubSubConnection requires. Further details are defined in 6.4.1.1.1.
The parameter shall be null or empty if no QoS related parameters are set.
The DatagramQos parameter contains QoS related parameters for the PubSubConnection as array of QosDataType Structures. The abstract DataType is defined in 6.4.1.1.2. The concrete subtypes are used to represent different QoS settings for transmit and receive that can be combined in the array.
The parameter shall be null or empty if no QoS related parameters are set.
This Structure DataType is used to represent the datagram specific transport mapping parameters for a PubSubConnection.
It is a subtype of the DatagramConnectionTransportDataType defined in 6.4.1.2.2.
The DatagramConnectionTransport2DataType is formally defined in Table 116.
Table 116 – DatagramConnectionTransport2DataType structure
|
Name |
Type |
Description |
Allow Subtypes |
|
DatagramConnectionTransport2DataType |
Structure |
Subtype of ConnectionTransportDataType defined in 6.2.6.4. |
|
|
DiscoveryAnnounceRate |
UInt32 |
Defined in 6.4.1.2.3. |
|
|
DiscoveryMaxMessageSize |
UInt32 |
Defined in 6.4.1.2.4. |
|
|
QosCategory |
String |
Defined in 6.4.1.2.5. |
|
|
DatagramQos |
QosDataType[] |
Defined in 6.4.1.2.6. |
True |
Its representation in the AddressSpace is defined in Table 117.
Table 117 – DatagramConnectionTransport2DataType definition
|
Attributes |
Value |
|
BrowseName |
DatagramConnectionTransport2DataType |
|
IsAbstract |
False |
|
Subtype of DatagramConnectionTransportDataType defined in 6.4.1.2.2. |
|
|
Conformance Units |
|
|
PubSub Parameters Datagram |
|
The MessageRepeatCount with DataType Byte defines how many times every NetworkMessage is repeated. The default value is 0 and disables the repeating.
The MessageRepeatDelay with DataType Duration defines the time between NetworkMessage repeats in milliseconds. The parameter shall be ignored if the parameter MessageRepeatCount is set to 0.
This Structure DataType is used to represent the datagram specific transport mapping parameters for WriterGroups. It is a subtype of the WriterGroupTransportDataType defined in 6.2.6.7.2.
The DatagramWriterGroupTransportDataType is formally defined in Table 118.
Table 118 – DatagramWriterGroupTransportDataType structure
|
Name |
Type |
Description |
|
DatagramWriterGroupTransportDataType |
Structure |
Subtype of WriterGroupTransportDataType defined in 6.2.6.7.2. |
|
MessageRepeatCount |
Byte |
Defined in 6.4.1.3.1. |
|
MessageRepeatDelay |
Duration |
Defined in 6.4.1.3.2. |
Its representation in the AddressSpace is defined in Table 119.
Table 119 – DatagramWriterGroupTransportDataType definition
|
Attributes |
Value |
|
BrowseName |
DatagramWriterGroupTransportDataType |
|
IsAbstract |
False |
|
Subtype of WriterGroupTransportDataType defined in 6.2.6.7.2. |
|
|
Conformance Units |
|
|
PubSub Parameters Datagram |
|
The Address parameter contains the network address information for the communication middleware related to the WriterGroup. The different Structure DataTypes used to represent the Address are defined in 6.2.7.5.3.
The parameter shall be null if an address is not set at this level. If the parameter is set, it overwrites the Address on the PubSubConnection.
Selects the general category of QoS the WriterGroup requires. Further details are defined in 6.4.1.1.1.
The parameter shall be null or empty if no QoS related parameters are set.
The DatagramQos parameter contains QoS related parameters for the WriterGroup as array of TransmitQosDataType Structures. The abstract TransmitQosDataType is defined in 6.4.1.1.3. The concrete subtypes are used to represent different QoS settings that can be combined in the array.
The parameter shall be null or empty if no QoS related parameters are set.
The DiscoveryAnnounceRate with DataType UInt32 defines the interval in seconds used for cyclic sending of discovery announcement messages related to the WriterGroup.
The default value is 0 and defines that discovery announcement messages are only sent as response to discovery probe messages.
The Topic parameter with DataType String contains the unique name of the data stream produced by the WriterGroup within a Message Oriented Middleware.
A unique default name can be created by combining the PublisherId with the WriterGroupId using ‘.’ As separator.
This Structure DataType is used to represent the datagram specific transport mapping parameters for WriterGroups. It is a subtype of the DatagramWriterGroupTransportDataType defined in 6.4.1.3.3.
The DatagramWriterGroupTransportDataType is formally defined in Table 120.
Table 120 – DatagramWriterGroupTransport2DataType structure
|
Name |
Type |
Description |
Allow Subtypes |
|
DatagramWriterGroupTransport2DataType |
Structure |
Subtype of DatagramWriterGroupTransportDataType defined in 6.4.1.3.3. |
|
|
Address |
NetworkAddressDataType |
Defined in 6.4.1.3.4. |
True |
|
QosCategory |
String |
Defined in 6.4.1.3.5. |
|
|
DatagramQos |
TransmitQosDataType[] |
Defined in 6.4.1.3.6. |
True |
|
DiscoveryAnnounceRate |
UInt32 |
Defined in 6.4.1.3.7. |
|
|
Topic |
String |
Defined in 6.4.1.3.8. |
|
Its representation in the AddressSpace is defined in Table 121.
Table 121 – DatagramWriterGroupTransport2DataType definition
|
Attributes |
Value |
|
BrowseName |
DatagramWriterGroupTransport2DataType |
|
IsAbstract |
False |
|
Subtype of DatagramWriterGroupTransportDataType defined in 6.4.1.3.3. |
|
|
Conformance Units |
|
|
PubSub Parameters Datagram |
|
There are no datagram-specific transport mapping parameters defined for the ReaderGroup.
There are no datagram-specific transport mapping parameters defined for the DataSetWriter.
The Address parameter contains the network address information for the communication middleware related to the DataSetReader. The different Structure DataTypes used to represent the Address are defined in 6.2.7.5.3.
The parameter shall be null if an address is not set at this level. If the parameter is set, it overwrites the Address on the PubSubConnection.
Selects the general categorty of QoS the DataSetReader requires. Further details are defined in 6.4.1.1.1.
The parameter shall be null or empty if no QoS related parameters are set.
The DatagramQos parameter contains the QoS related parameters for the DataSetReader as array of ReceiveQosDataType Structures. The abstract ReceiveQosDataType is defined in 6.4.1.1.5. The concrete subtypes are used to represent different QoS settings that can be combined in the array.
The parameter shall be null or empty if no QoS related parameters are set.
The Topic parameter with DataType String contains the unique name of the data stream from the Publisher that contains the DataSetMessages of interest for the DataSetReader. The Topic is defined by the Publisher.
This Structure DataType is used to represent the datagram transport mapping parameters for DataSetReaders. It is a subtype of the DataSetReaderTransportDataType defined in 6.2.9.13.2.
The DatagramDataSetReaderTransportDataType is formally defined in Table 122.
Table 122 – DatagramDataSetReaderTransportDataType structure
|
Name |
Type |
Description |
Allow Subtypes |
|
DatagramDataSetReaderTransportDataType |
Structure |
Subtype of DataSetReaderTransportDataType defined in 6.2.9.13.2. |
|
|
Address |
NetworkAddressDataType |
Defined in 6.4.1.6.1. |
True |
|
QosCategory |
String |
Defined in 6.4.1.6.2. |
|
|
DatagramQos |
ReceiveQosDataType[] |
Defined in 6.4.1.6.3. |
True |
|
Topic |
String |
Defined in 6.4.1.6.4. |
|
Its representation in the AddressSpace is defined in Table 123.
Table 123 – DatagramDataSetReaderTransportDataType definition
|
Attributes |
Value |
|
BrowseName |
DatagramDataSetReaderTransportDataType |
|
IsAbstract |
False |
|
Subtype of DataSetReaderTransportDataType defined in 6.2.9.13.2. |
|
|
Conformance Units |
|
|
PubSub Parameters Datagram |
|
The BrokerTransportQualityOfService Enumeration DataType is formally defined in Table 124.
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 124 – BrokerTransportQualityOfService values
|
Name |
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 shall 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. |
The BrokerTransportQualityOfService representation in the AddressSpace is defined in Table 125.
Table 125 – BrokerTransportQualityOfService definition
|
Attribute |
Value |
||||
|
BrowseName |
BrokerTransportQualityOfService |
||||
|
IsAbstract |
False |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
Others |
|
Subtype of Enumeration defined in OPC 10000-5 |
|||||
|
HasProperty |
Variable |
EnumStrings |
LocalizedText [] |
PropertyType |
|
|
Conformance Units |
|||||
|
PubSub Parameters Broker |
|||||
The ResourceUri parameter of DataType String enables the transport implementation to look up a configured key from the corresponding KeyCredentialConfigurationType instance defined in OPC 10000-12 to use for authenticating access to the Broker at the connection level or for queues configured below the connection.
If null or empty, 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.
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 or empty, 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.
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.7.5.2.
The BrokerConnectionTransportDataType is formally defined in Table 126.
Table 126 – BrokerConnectionTransportDataType structure
|
Name |
Type |
Description |
|
BrokerConnectionTransportDataType |
Structure |
Subtype of the ConnectionTransportDataType defined in 6.2.6.4. |
|
ResourceUri |
String |
Defined in 6.4.2.2.1. |
|
AuthenticationProfileUri |
String |
Defined in 6.4.2.2.2. |
Its representation in the AddressSpace is defined in Table 127.
Table 127 – BrokerConnectionTransportDataType definition
|
Attributes |
Value |
|
BrowseName |
BrokerConnectionTransportDataType |
|
IsAbstract |
False |
|
Subtype of ConnectionTransportDataType defined in 6.2.7.5.2. |
|
|
Conformance Units |
|
|
PubSub Parameters Broker |
|
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.
The ResourceUri property of DataType String allows the transport implementation to look up the configured key from the corresponding KeyCredentialConfigurationType instance defined in OPC 10000-12 to use for authenticating access to the specified queue.
If this String is not null or empty, it overrides the ResourceUri of the PubSubConnection authentication settings.
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 or empty, it overrides the AuthenticationProfileUri of the PubSubConnection transport settings defined in 6.4.2.2.2.
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.1.
The value NotSpecified is not allowed on the WriterGroup. If the selected delivery guarantee cannot be applied, the WriterGroup shall set the state to Error.
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.6.7.2.
The BrokerWriterGroupTransportDataType is formally defined in Table 128.
Table 128 – BrokerWriterGroupTransportDataType structure
|
Name |
Type |
Description |
|
BrokerWriterGroupTransportDataType |
Structure |
Subtype of WriterGroupTransportDataType defined in 6.2.6.7.2. |
|
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. |
Its representation in the AddressSpace is defined in Table 129.
Table 129 – BrokerWriterGroupTransportDataType definition
|
Attributes |
Value |
|
BrowseName |
BrokerWriterGroupTransportDataType |
|
IsAbstract |
False |
|
Subtype of WriterGroupTransportDataType defined in 6.2.6.7.2. |
|
|
Conformance Units |
|
|
PubSub Parameters Broker |
|
There are no broker specific transport mapping parameters defined for the ReaderGroup.
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 for this DataSetWriter contain only DataSetMessages from this DataSetWriter.
If this String is not null or empty, it overrides the QueueName of the WriterGroup transport settings.
The ResourceUri property of DataType String allows the transport implementation to look up the configured key from the corresponding KeyCredentialConfigurationType instance defined in OPC 10000-12 to use for authenticating access to the specified queue.
If this String is not null or empty, it overrides the ResourceUri of the WriterGroup authentication settings.
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 or empty, it overrides the AuthenticationProfileUri of the WriterGroup transport settings.
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.1.
If the value is not NotSpecified, it overrides the RequestedDeliveryGuarantee of the WriterGroup transport settings. Overriding the WriterGroup setting is only valid if the DataSetWriter also overrides the QueueName.
If the selected delivery guarantee cannot be applied, the DataSetWriter shall set the state to Error.
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.
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 to 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 or ExactlyOnce delivery guarantees with the broker for any DataSetMetaData sent to ensure metadata is available to readers.
The DataSetWriterProperties settings apply also to DataSetMetaData sent to the queue named through the MetaDataQueueName parameter.
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.4.5.2.
The BrokerDataSetWriterTransportDataType is formally defined in Table 130.
Table 130 – BrokerDataSetWriterTransportDataType structure
|
Name |
Type |
Description |
|
BrokerDataSetWriterTransportDataType |
Structure |
Subtype of DataSetWriterTransportDataType defined in 6.2.4.5.2. |
|
QueueName |
String |
Defined in 6.4.2.5.1. |
|
ResourceUri |
String |
Defined in 6.4.2.5.2. |
|
AuthenticationProfileUri |
String |
Defined in 6.4.2.5.3. |
|
RequestedDeliveryGuarantee |
BrokerTransportQualityOfService |
Defined in 6.4.2.5.4. |
|
MetaDataQueueName |
String |
Defined in 6.4.2.5.5. |
|
MetaDataUpdateTime |
Duration |
Defined in 6.4.2.5.6. |
Its representation in the AddressSpace is defined in Table 131.
Table 131 – BrokerDataSetWriterTransportDataType definition
|
Attributes |
Value |
|
BrowseName |
BrokerDataSetWriterTransportDataType |
|
IsAbstract |
False |
|
Subtype of DataSetWriterTransportDataType defined in 6.2.4.5.2. |
|
|
Conformance Units |
|
|
PubSub Parameters Broker |
|
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.
The ResourceUri property of DataType String allows the transport implementation to look up the configured key from the corresponding KeyCredentialConfigurationType instance defined in OPC 10000-12 to use for authenticating access to the specified queue.
If this String is not null or empty, it overrides the ResourceUri of the PubSubConnection authentication settings.
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 or empty, it overrides the AuthenticationProfileUri of the PubSubConnection transport settings defined in 6.4.2.2.2.
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.1.
The value NotSpecified is not allowed on the DataSetReader. If the selected delivery guarantee cannot be applied, the DataSetReader shall set the state to Error.
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.
This Structure DataType is used to represent the broker-specific transport mapping parameters for DataSetReaders. It is a subtype of the DataSetReaderTransportDataType defined in 6.2.9.13.2.
The BrokerDataSetReaderTransportDataType is formally defined in Table 132.
Table 132 – BrokerDataSetReaderTransportDataType structure
|
Name |
Type |
Description |
|
BrokerDataSetReaderTransportDataType |
Structure |
Subtype of DataSetReaderTransportDataType defined in 6.2.9.13.2. |
|
QueueName |
String |
Defined in 6.4.2.6.1. |
|
ResourceUri |
String |
Defined in 6.4.2.6.2. |
|
AuthenticationProfileUri |
String |
Defined in 6.4.2.6.3. |
|
RequestedDeliveryGuarantee |
BrokerTransportQualityOfService |
Defined in 6.4.2.6.4. |
|
MetaDataQueueName |
String |
Defined in 6.4.2.6.5. |
Its representation in the AddressSpace is defined in Table 133.
Table 133 – BrokerDataSetReaderTransportDataType definition
|
Attributes |
Value |
|
BrowseName |
BrokerDataSetReaderTransportDataType |
|
IsAbstract |
False |
|
Subtype of DataSetReaderTransportDataType defined in 6.2.9.13.2. |
|
|
Conformance Units |
|
|
PubSub Parameters Broker |
|