'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Function SubscribeDeviceMetric( _
   ByVal consumer As IEasySparkplugConsumer, _
   ByVal hostDescriptor As SparkplugHostDescriptor, _
   ByVal deviceDescriptor As SparkplugDeviceDescriptor, _
   ByVal metricName As String, _
   ByVal callback As EasySparkplugMetricNotificationEventHandler _
) As Integer

'Usage
 
Dim consumer As IEasySparkplugConsumer
Dim hostDescriptor As SparkplugHostDescriptor
Dim deviceDescriptor As SparkplugDeviceDescriptor
Dim metricName As String
Dim callback As EasySparkplugMetricNotificationEventHandler
Dim value As Integer
 
value = IEasySparkplugConsumerExtension.SubscribeDeviceMetric(consumer, hostDescriptor, deviceDescriptor, metricName, callback)

[Extension()]
public static int SubscribeDeviceMetric( 
   IEasySparkplugConsumer consumer,
   SparkplugHostDescriptor hostDescriptor,
   SparkplugDeviceDescriptor deviceDescriptor,
   string metricName,
   EasySparkplugMetricNotificationEventHandler callback
)

[Extension()]
public:
static int SubscribeDeviceMetric( 
   IEasySparkplugConsumer^ consumer,
   SparkplugHostDescriptor^ hostDescriptor,
   SparkplugDeviceDescriptor^ deviceDescriptor,
   String^ metricName,
   EasySparkplugMetricNotificationEventHandler^ 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).

deviceDescriptor

The Sparkplug device descriptor.

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

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.

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows