SubscribeMetric Method (IEasySparkplugConsumer)

Subscribes to notifications for the specified metric on an edge node or device.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Function SubscribeMetric( _
   ByVal metricSubscriptionArguments As EasySparkplugMetricSubscriptionArguments _
) As Integer

'Usage
 
Dim instance As IEasySparkplugConsumer
Dim metricSubscriptionArguments As EasySparkplugMetricSubscriptionArguments
Dim value As Integer
 
value = instance.SubscribeMetric(metricSubscriptionArguments)

int SubscribeMetric( 
   EasySparkplugMetricSubscriptionArguments metricSubscriptionArguments
)

int SubscribeMetric( 
   EasySparkplugMetricSubscriptionArguments^ metricSubscriptionArguments
)

Parameters

metricSubscriptionArguments: The Sparkplug metric subscription arguments.
The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

Returns a metric subscription handle that can be used to unsubscribe.

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.ObjectDisposedException	An operation was performed on a disposed object.

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.ObjectDisposedException An operation was performed on a disposed object.

Remarks

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

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

IEasySparkplugConsumer Interface
IEasySparkplugConsumer Members
AutoStartStop Property
AutoGeneratedHostId Property

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.