Connectivity Software User's Guide and Reference
EasySparkplugEdgeNode Constructor(SparkplugSystemDescriptor,String,String,String)



OpcLabs.EasySparkplugComponents Assembly > OpcLabs.EasySparkplug Namespace > EasySparkplugEdgeNode Class > EasySparkplugEdgeNode Constructor : EasySparkplugEdgeNode Constructor(SparkplugSystemDescriptor,String,String,String)
The Sparkplug system descriptor.

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

The host ID of the primary host application that this edge node is associated with.

The value represents a Sparkplug host ID. It must be a string with valid UTF-8 characters except for the reserved characters of '+' (plus) and '#' (number sign).

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

The Sparkplug group ID of this edge node.

The value represents a Sparkplug group ID. It must be a string with valid UTF-8 characters except for the reserved characters of '+' (plus), '/' (forward slash), and '#' (number sign).

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

The Sparkplug edge node ID of this edge node.

The value represents a Sparkplug edge node ID. It must be a string with valid UTF-8 characters except for the reserved characters of '+' (plus), '/' (forward slash), and '#' (number sign).

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

Initializes a new instance of the class with the specified Sparkplug system descriptor, primary host ID, group ID, and edge node ID.
Syntax
'Declaration
 
Public Function New( _
   ByVal systemDescriptor As SparkplugSystemDescriptor, _
   ByVal primaryHostId As String, _
   ByVal groupId As String, _
   ByVal edgeNodeId As String _
)
'Usage
 
Dim systemDescriptor As SparkplugSystemDescriptor
Dim primaryHostId As String
Dim groupId As String
Dim edgeNodeId As String
 
Dim instance As New EasySparkplugEdgeNode(systemDescriptor, primaryHostId, groupId, edgeNodeId)

Parameters

systemDescriptor
The Sparkplug system descriptor.

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

primaryHostId
The host ID of the primary host application that this edge node is associated with.

The value represents a Sparkplug host ID. It must be a string with valid UTF-8 characters except for the reserved characters of '+' (plus) and '#' (number sign).

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

groupId
The Sparkplug group ID of this edge node.

The value represents a Sparkplug group ID. It must be a string with valid UTF-8 characters except for the reserved characters of '+' (plus), '/' (forward slash), and '#' (number sign).

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

edgeNodeId
The Sparkplug edge node ID of this edge node.

The value represents a Sparkplug edge node ID. It must be a string with valid UTF-8 characters except for the reserved characters of '+' (plus), '/' (forward slash), and '#' (number sign).

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

Exceptions
ExceptionDescription

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

 

Sparkplug is a trademark of Eclipse Foundation, Inc. "MQTT" is a trademark of the OASIS Open standards consortium. Other related terms are trademarks of their respective owners. Any use of these terms on this site is for descriptive purposes only and does not imply any sponsorship, endorsement or affiliation.

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