Connectivity Software User's Guide and Reference
PublishEdgeNodeMetric(IEasySparkplugConsumer,SparkplugHostDescriptor,String,String,String,SparkplugMetricData) Method



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace > IEasySparkplugConsumerExtension Class > PublishEdgeNodeMetric Method : PublishEdgeNodeMetric(IEasySparkplugConsumer,SparkplugHostDescriptor,String,String,String,SparkplugMetricData) Method
The consumer object that will perform the operation.

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

The Sparkplug host descriptor.

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

The Sparkplug group ID.

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.

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

The name of the Sparkplug metric.

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

The Sparkplug metric data.

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

Publishes a single metric for an edge node, specifying the host descriptor, group ID, edge node ID, metric name and metric data.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Sub PublishEdgeNodeMetric( _
   ByVal consumer As IEasySparkplugConsumer, _
   ByVal hostDescriptor As SparkplugHostDescriptor, _
   ByVal groupId As String, _
   ByVal edgeNodeId As String, _
   ByVal metricName As String, _
   ByVal metricData As SparkplugMetricData _
) 
'Usage
 
Dim consumer As IEasySparkplugConsumer
Dim hostDescriptor As SparkplugHostDescriptor
Dim groupId As String
Dim edgeNodeId As String
Dim metricName As String
Dim metricData As SparkplugMetricData
 
IEasySparkplugConsumerExtension.PublishEdgeNodeMetric(consumer, hostDescriptor, groupId, edgeNodeId, metricName, metricData)

Parameters

consumer
The consumer object that will perform the operation.

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

hostDescriptor
The Sparkplug host descriptor.

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

groupId
The Sparkplug group ID.

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.

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

metricName
The name of the Sparkplug metric.

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

metricData
The Sparkplug metric data.

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.

The Sparkplug operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

 

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