Connectivity Software User's Guide and Reference
UpdateFromElements Method (UASubscriberCommunicationParameters)



OpcLabs.EasyOpcUAPrimitives Assembly > OpcLabs.EasyOpc.UA.PubSub Namespace > UASubscriberCommunicationParameters Class : UpdateFromElements Method
The subscriber communication parameters to update.

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

The endpoint descriptor of the publisher.

Because the OpcLabs.EasyOpc.UA.UAEndpointDescriptor has implicit conversions from System.String and System.Uri, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the endpoint URL, or a so-called OPC UA endpoint descriptor string), or a System.Uri object, in place of this parameter, and the corresponding endpoint descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.UA.UAEndpointDescriptor.FromString or OpcLabs.EasyOpc.UA.UAEndpointDescriptor.FromUri static method instead.

Also, because the OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement and OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement have an implicit conversion to OpcLabs.EasyOpc.UA.UAEndpointDescriptor, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement or OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement (results from OPC UA discovery) in place of this parameter, and the corresponding endpoint descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can convert a (non-null) OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement or OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement to OpcLabs.EasyOpc.UA.UAEndpointDescriptor using the OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement.ToUAEndpointDescriptor or OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement.ToUAEndpointDescriptor method instead.

If you are using OPC Wizard (for server development), an implicit conversion from OpcLabs.EasyOpc.UA.EasyUAServerCore can be used in the same way to simply pass the server object in place of this parameter, which will use its OpcLabs.EasyOpc.UA.EasyUAServerCore.EffectiveServerDescriptor property for the connection.

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

The effective transport profile URI string.

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

The dataset metadata.

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

The PubSub configuration element.

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

The writer group element containing publishing information.

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

The dataset writer element.

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

The amount to increase the message receive timeout. In milliseconds.
The factor by which to multiply the base timeout to calculate the message receive timeout.
Updates subscriber communication parameters from OPC UA PubSub configuration elements.
Syntax
'Usage
 
Dim subscriberCommunicationParameters As UASubscriberCommunicationParameters
Dim publisherEndpointDescriptor As UAEndpointDescriptor
Dim effectiveTransportProfileUriString As String
Dim dataSetMetaData As UADataSetMetaData
Dim pubSubConfigurationElement As UAPubSubConfigurationElement
Dim writerGroupElement As UAWriterGroupElement
Dim dataSetWriterElement As UADataSetWriterElement
Dim messageReceiveTimeoutIncrease As Double
Dim messageReceiveTimeoutFactor As Double
 
UASubscriberCommunicationParameters.UpdateFromElements(subscriberCommunicationParameters, publisherEndpointDescriptor, effectiveTransportProfileUriString, dataSetMetaData, pubSubConfigurationElement, writerGroupElement, dataSetWriterElement, messageReceiveTimeoutIncrease, messageReceiveTimeoutFactor)

Parameters

subscriberCommunicationParameters
The subscriber communication parameters to update.

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

publisherEndpointDescriptor
The endpoint descriptor of the publisher.

Because the OpcLabs.EasyOpc.UA.UAEndpointDescriptor has implicit conversions from System.String and System.Uri, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the endpoint URL, or a so-called OPC UA endpoint descriptor string), or a System.Uri object, in place of this parameter, and the corresponding endpoint descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.UA.UAEndpointDescriptor.FromString or OpcLabs.EasyOpc.UA.UAEndpointDescriptor.FromUri static method instead.

Also, because the OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement and OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement have an implicit conversion to OpcLabs.EasyOpc.UA.UAEndpointDescriptor, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement or OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement (results from OPC UA discovery) in place of this parameter, and the corresponding endpoint descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can convert a (non-null) OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement or OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement to OpcLabs.EasyOpc.UA.UAEndpointDescriptor using the OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement.ToUAEndpointDescriptor or OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement.ToUAEndpointDescriptor method instead.

If you are using OPC Wizard (for server development), an implicit conversion from OpcLabs.EasyOpc.UA.EasyUAServerCore can be used in the same way to simply pass the server object in place of this parameter, which will use its OpcLabs.EasyOpc.UA.EasyUAServerCore.EffectiveServerDescriptor property for the connection.

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

effectiveTransportProfileUriString
The effective transport profile URI string.

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

dataSetMetaData
The dataset metadata.

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

pubSubConfigurationElement
The PubSub configuration element.

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

writerGroupElement
The writer group element containing publishing information.

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

dataSetWriterElement
The dataset writer element.

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

messageReceiveTimeoutIncrease
The amount to increase the message receive timeout. In milliseconds.
messageReceiveTimeoutFactor
The factor by which to multiply the base timeout to calculate the message receive timeout.
Remarks

This method configures the subscriber communication parameters based on the publisher's configuration elements, including security settings, message parameters, transport parameters, and timeout calculations.

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