Connectivity Software User's Guide and Reference
UADataSetSubscriptionDescriptor Constructor(UAPubSubConnectionDescriptor,UASubscriberCommunicationParameters,UASubscribeDataSetFilter,String,UADataSetMetaData,UAPubSubResolverDescriptor)



OpcLabs.EasyOpcUAPrimitives Assembly > OpcLabs.EasyOpc.UA.PubSub Namespace > UADataSetSubscriptionDescriptor Class > UADataSetSubscriptionDescriptor Constructor : UADataSetSubscriptionDescriptor Constructor(UAPubSubConnectionDescriptor,UASubscriberCommunicationParameters,UASubscribeDataSetFilter,String,UADataSetMetaData,UAPubSubResolverDescriptor)
Descriptor for a PubSub connection (using physical parameters, or logical name).

Because the UAPubSubConnectionDescriptor has an implicit conversion from OpcLabs.BaseLib.Networking.ResourceAddress and System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.BaseLib.Networking.ResourceAddress object, or a string (the so-called resource description string, usually a resource URL) in place of this parameter, and the corresponding OPC UA PubSub connection descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the UAPubSubConnectionDescriptor.FromResourceAddress or UAWriterGroupDescriptor.FromString static method instead.

Also, because the OpcLabs.EasyOpc.UA.PubSub.Configuration.UAPubSubConnectionElement has an implicit conversion to UAPubSubConnectionDescriptor, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.EasyOpc.UA.PubSub.Configuration.UAPubSubConnectionElement (from PubSub configuration) in place of this parameter, and the corresponding OPC UA PubSub connection descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can convert a OpcLabs.EasyOpc.UA.PubSub.Configuration.UAPubSubConnectionElement to UAPubSubConnectionDescriptor using the OpcLabs.EasyOpc.UA.PubSub.Configuration.UAPubSubConnectionElement.ToUAPubSubConnectionDescriptor static method instead.

The value of this parameter cannot be null (Nothing in Visual Basic).

Represents communication parameters for an OPC UA subscriber.

The value of this parameter cannot be null (Nothing in Visual Basic).

Specifies how the incoming PubSub messages should be filtered before being delivered to the application.

Because the UASubscribeDataSetFilter has an implicit conversion from UAPublisherId, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a UAPublisherId (containing the publisher Id that you want to allow in the filter) in place of this parameter, and the corresponding OPC UA subscribe dataset filter will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the UASubscribeDataSetFilter.FromUAPublisherId static method instead.

The value of this parameter cannot be null (Nothing in Visual Basic).

Name of the published dataset.

The value of this parameter cannot be null (Nothing in Visual Basic).

Metadata for the dataset.

The value of this parameter can be null (Nothing in Visual Basic).

Describes how the PubSub logical information should be resolved to physical.

The value of this parameter cannot be null (Nothing in Visual Basic).

Initializes a new instance of the class, specifying the PubSub connection descriptor, communication parameters, filter, published dataset name, dataset metadata, and resolver descriptor.
Syntax

Parameters

connectionDescriptor
Descriptor for a PubSub connection (using physical parameters, or logical name).

Because the UAPubSubConnectionDescriptor has an implicit conversion from OpcLabs.BaseLib.Networking.ResourceAddress and System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.BaseLib.Networking.ResourceAddress object, or a string (the so-called resource description string, usually a resource URL) in place of this parameter, and the corresponding OPC UA PubSub connection descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the UAPubSubConnectionDescriptor.FromResourceAddress or UAWriterGroupDescriptor.FromString static method instead.

Also, because the OpcLabs.EasyOpc.UA.PubSub.Configuration.UAPubSubConnectionElement has an implicit conversion to UAPubSubConnectionDescriptor, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.EasyOpc.UA.PubSub.Configuration.UAPubSubConnectionElement (from PubSub configuration) in place of this parameter, and the corresponding OPC UA PubSub connection descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can convert a OpcLabs.EasyOpc.UA.PubSub.Configuration.UAPubSubConnectionElement to UAPubSubConnectionDescriptor using the OpcLabs.EasyOpc.UA.PubSub.Configuration.UAPubSubConnectionElement.ToUAPubSubConnectionDescriptor static method instead.

The value of this parameter cannot be null (Nothing in Visual Basic).

communicationParameters
Represents communication parameters for an OPC UA subscriber.

The value of this parameter cannot be null (Nothing in Visual Basic).

filter
Specifies how the incoming PubSub messages should be filtered before being delivered to the application.

Because the UASubscribeDataSetFilter has an implicit conversion from UAPublisherId, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a UAPublisherId (containing the publisher Id that you want to allow in the filter) in place of this parameter, and the corresponding OPC UA subscribe dataset filter will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the UASubscribeDataSetFilter.FromUAPublisherId static method instead.

The value of this parameter cannot be null (Nothing in Visual Basic).

publishedDataSetName
Name of the published dataset.

The value of this parameter cannot be null (Nothing in Visual Basic).

dataSetMetaData
Metadata for the dataset.

The value of this parameter can be null (Nothing in Visual Basic).

resolverDescriptor
Describes how the PubSub logical information should be resolved to physical.

The value of this parameter cannot be null (Nothing in Visual Basic).

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also