Connectivity Software User's Guide and Reference
SubscribeEdgeNodeMetric(IEasySparkplugConsumer,SparkplugHostDescriptor,String,String,String,EasySparkplugMetricNotificationEventHandler) Method
Example 



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace > IEasySparkplugConsumerExtension Class > SubscribeEdgeNodeMetric Method : SubscribeEdgeNodeMetric(IEasySparkplugConsumer,SparkplugHostDescriptor,String,String,String,EasySparkplugMetricNotificationEventHandler) 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, or a filter for Sparkplug group IDs. It must be a string with valid UTF-8 characters except for the reserved character '/' (forward slash). Characters '+' (plus) and '#' are filters, and can only be used when they are the single character in the string.

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, or a filter for Sparkplug edge node IDs. It must be a string with valid UTF-8 characters except for the reserved character '/' (forward slash). Characters '+' (plus) and '#' are filters, and can only be used when they are the single character in the string.

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

The Sparkplug metric name.

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

The callback to invoke for the notification.

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

Subscribes to an edge node metric, specifying the host descriptor, group ID, edge node ID, metric name, and callback.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Function SubscribeEdgeNodeMetric( _
   ByVal consumer As IEasySparkplugConsumer, _
   ByVal hostDescriptor As SparkplugHostDescriptor, _
   ByVal groupId As String, _
   ByVal edgeNodeId As String, _
   ByVal metricName As String, _
   ByVal callback As EasySparkplugMetricNotificationEventHandler _
) As Integer
'Usage
 
Dim consumer As IEasySparkplugConsumer
Dim hostDescriptor As SparkplugHostDescriptor
Dim groupId As String
Dim edgeNodeId As String
Dim metricName As String
Dim callback As EasySparkplugMetricNotificationEventHandler
Dim value As Integer
 
value = IEasySparkplugConsumerExtension.SubscribeEdgeNodeMetric(consumer, hostDescriptor, groupId, edgeNodeId, metricName, callback)

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, or a filter for Sparkplug group IDs. It must be a string with valid UTF-8 characters except for the reserved character '/' (forward slash). Characters '+' (plus) and '#' are filters, and can only be used when they are the single character in the string.

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, or a filter for Sparkplug edge node IDs. It must be a string with valid UTF-8 characters except for the reserved character '/' (forward slash). Characters '+' (plus) and '#' are filters, and can only be used when they are the single character in the string.

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

metricName
The Sparkplug metric name.

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

callback
The callback to invoke for the notification.

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

Return Value

Returns a metric subscription handle that can be used to unsubscribe.
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

To unsubscribe from the metric, use the UnsubscribeMetric, UnsubscribeAllMetrics or UnsubscribeAll method.

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.

Example
// This example shows how to subscribe to changes of a single metric, and display the value of the metric with each change
// using a callback method that is provided as lambda expression.
//
// In order to publish or observe messages for this example, start the SparkplugEdgeNodeConsoleDemo program first.
//
// Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-ConnectivityStudio/Latest/examples.html .
// Sparkplug examples in C# on GitHub: https://github.com/OPCLabs/Examples-ConnectivityStudio-CSharp .
// Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own
// a commercial license in order to use Online Forums, and we reply to every post.

using OpcLabs.EasySparkplug;
using System;

namespace SparkplugDocExamples.Consumer._EasySparkplugConsumer
{
    partial class SubscribeEdgeNodeMetric
    {
        public static void CallbackLambda()
        {
            // Note that the default port for the "mqtt" scheme is 1883.
            var hostDescriptor = new SparkplugHostDescriptor("mqtt://localhost");

            // Instantiate the consumer object.
            var consumer = new EasySparkplugConsumer();

            Console.WriteLine("Subscribing...");
            // The callback is a lambda expression the displays the value
            // In this example, we specify the precise Sparkplug group ID, edge node ID, and metric name.
            consumer.SubscribeEdgeNodeMetric(hostDescriptor, 
                "easyGroup", "easySparkplugDemo", "Random",
                (sender, eventArgs) =>
                {
                    if (eventArgs.Succeeded)
                    {
                        if (eventArgs.HasData)
                            Console.WriteLine("Value: {0}", eventArgs.MetricData?.Value);
                    }
                    else
                        Console.WriteLine("*** Failure: {0}", eventArgs.ErrorMessageBrief);
                });

            Console.WriteLine("Processing notifications for 20 seconds...");
            System.Threading.Thread.Sleep(20 * 1000);

            Console.WriteLine("Unsubscribing...");
            consumer.UnsubscribeAllMetrics();

            Console.WriteLine("Waiting for 5 seconds...");
            System.Threading.Thread.Sleep(5 * 1000);

            Console.WriteLine("Finished.");
        }
    }
}
' This example shows how to subscribe to changes of a single metric, and display the value of the metric with each change
' using a callback method that is provided as lambda expression.
'
' In order to publish or observe messages for this example, start the SparkplugEdgeNodeConsoleDemo program first.
'
' Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-ConnectivityStudio/Latest/examples.html .
' Sparkplug examples in C# on GitHub: https://github.com/OPCLabs/Examples-ConnectivityStudio-CSharp .
' Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own
' a commercial license in order to use Online Forums, and we reply to every post.

Imports OpcLabs.EasySparkplug

Namespace Global.SparkplugDocExamples.Consumer._EasySparkplugConsumer
    Partial Class SubscribeEdgeNodeMetric
        Public Shared Sub CallbackLambda()
            ' Note that the default port for the "mqtt" scheme is 1883.
            Dim hostDescriptor = New SparkplugHostDescriptor("mqtt://localhost")

            ' Instantiate the consumer object.
            Dim consumer = New EasySparkplugConsumer()

            Console.WriteLine("Subscribing...")
            ' The callback is a lambda expression the displays the value
            ' In this example, we specify the precise Sparkplug group ID, edge node ID, and metric name.

            consumer.SubscribeEdgeNodeMetric(hostDescriptor,
                "easyGroup", "easySparkplugDemo", "Random",
                Sub(sender, eventArgs)
                    If (eventArgs.Succeeded) Then
                        If (eventArgs.HasData) Then
                            Console.WriteLine("Value: {0}", eventArgs.MetricData?.Value)
                        End If
                    Else
                        Console.WriteLine("*** Failure: {0}", eventArgs.ErrorMessageBrief)
                    End If
                End Sub)

            Console.WriteLine("Processing notifications for 20 seconds...")
            Threading.Thread.Sleep(20 * 1000)

            Console.WriteLine("Unsubscribing...")
            consumer.UnsubscribeAllMetrics()

            Console.WriteLine("Waiting for 5 seconds...")
            Threading.Thread.Sleep(5 * 1000)

            Console.WriteLine("Finished.")
        End Sub
    End Class
End Namespace
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