BrokerDescriptor Property

Gets or sets the descriptor for the Sparkplug broker.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<JetBrains.Annotations.NotNullAttribute()>
Public Property BrokerDescriptor As SparkplugBrokerDescriptor

'Usage
 
Dim instance As SparkplugConnectionDescriptor
Dim value As SparkplugBrokerDescriptor
 
instance.BrokerDescriptor = value
 
value = instance.BrokerDescriptor

[JetBrains.Annotations.NotNull()]
public SparkplugBrokerDescriptor BrokerDescriptor {get; set;}

[JetBrains.Annotations.NotNull()]
public:
property SparkplugBrokerDescriptor^ BrokerDescriptor {
   SparkplugBrokerDescriptor^ get();
   void set (    SparkplugBrokerDescriptor^ value);
}

Property Value

A SparkplugBrokerDescriptor instance that represents the broker descriptor.

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

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	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.

System.ArgumentNullException

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

NOTE: The Sparkplug specification also describes scenarios in which multiple Sparkplug brokers are used in conjunction.

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

Reference

SparkplugConnectionDescriptor Class
SparkplugConnectionDescriptor Members

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.