'Declaration
 
<ExtensionAttribute()>
Public Shared Function SubscribePayload( _
   ByVal consumer As IEasySparkplugConsumer, _
   ByVal payloadSubscriptionArguments As SparkplugPayloadSubscriptionArguments, _
   ByVal payloadNotificationCallback As EasySparkplugPayloadNotificationEventHandler _
) As Integer

'Usage
 
Dim consumer As IEasySparkplugConsumer
Dim payloadSubscriptionArguments As SparkplugPayloadSubscriptionArguments
Dim payloadNotificationCallback As EasySparkplugPayloadNotificationEventHandler
Dim value As Integer
 
value = IEasySparkplugConsumerExtension.SubscribePayload(consumer, payloadSubscriptionArguments, payloadNotificationCallback)

[Extension()]
public static int SubscribePayload( 
   IEasySparkplugConsumer consumer,
   SparkplugPayloadSubscriptionArguments payloadSubscriptionArguments,
   EasySparkplugPayloadNotificationEventHandler payloadNotificationCallback
)

[Extension()]
public:
static int SubscribePayload( 
   IEasySparkplugConsumer^ consumer,
   SparkplugPayloadSubscriptionArguments^ payloadSubscriptionArguments,
   EasySparkplugPayloadNotificationEventHandler^ payloadNotificationCallback
) 

Parameters

consumer

The consumer object that will perform the operation.

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

payloadSubscriptionArguments

The Sparkplug payload subscription arguments.

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

payloadNotificationCallback

The callback to invoke for the payload notification.

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

Return Value

To unsubscribe from the payload, use the UnsubscribePayload, UnsubscribeAllPayloads 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