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



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace > IEasySparkplugConsumerExtension Class > PublishEdgeNodeMetric Method : PublishEdgeNodeMetric(IEasySparkplugConsumer,SparkplugEdgeNodeDescriptor,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 edge node descriptor.

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 edge node descriptor, metric name and metric data.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Sub PublishEdgeNodeMetric( _
   ByVal consumer As IEasySparkplugConsumer, _
   ByVal edgeNodeDescriptor As SparkplugEdgeNodeDescriptor, _
   ByVal metricName As String, _
   ByVal metricData As SparkplugMetricData _
) 
'Usage
 
Dim consumer As IEasySparkplugConsumer
Dim edgeNodeDescriptor As SparkplugEdgeNodeDescriptor
Dim metricName As String
Dim metricData As SparkplugMetricData
 
IEasySparkplugConsumerExtension.PublishEdgeNodeMetric(consumer, edgeNodeDescriptor, metricName, metricData)

Parameters

consumer
The consumer object that will perform the operation.

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

edgeNodeDescriptor
The Sparkplug edge node descriptor.

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

In Sparkplug terms, this method effectively sends the NCMD message to the edge node.

If there is an error publishing the payload, this method throws OpcLabs.EasySparkplug.OperationModel.SparkplugException.

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