Connectivity Software User's Guide and Reference
EasySparkplugConsumer Constructor(SparkplugBrokerDescriptor,String)



OpcLabs.EasySparkplugComponents Assembly > OpcLabs.EasySparkplug Namespace > EasySparkplugConsumer Class > EasySparkplugConsumer Constructor : EasySparkplugConsumer Constructor(SparkplugBrokerDescriptor,String)
An implicit broker descriptor, used when the host descriptor is not specified explicitly.

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

An implicit host ID, used when the host descriptor is not specified explicitly.

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).

Initializes a new instance of the class, specifying an implicit broker descriptor and an implicit host ID.
Syntax
'Declaration
 
Public Function New( _
   ByVal implicitBrokerDescriptor As SparkplugBrokerDescriptor, _
   ByVal implicitHostId As String _
)
'Usage
 
Dim implicitBrokerDescriptor As SparkplugBrokerDescriptor
Dim implicitHostId As String
 
Dim instance As New EasySparkplugConsumer(implicitBrokerDescriptor, implicitHostId)

Parameters

implicitBrokerDescriptor
An implicit broker descriptor, used when the host descriptor is not specified explicitly.

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

implicitHostId
An implicit host ID, used when the host descriptor is not specified explicitly.

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).

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