Connectivity Software User's Guide and Reference
SubscribeEdgeNodePayload(IEasySparkplugConsumer,SparkplugHostDescriptor,SparkplugEdgeNodeDescriptor) Method



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

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

Subscribes to payloads from an edge node, specifying the host descriptor and edge node descriptor.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Function SubscribeEdgeNodePayload( _
   ByVal consumer As IEasySparkplugConsumer, _
   ByVal hostDescriptor As SparkplugHostDescriptor, _
   ByVal edgeNodeDescriptor As SparkplugEdgeNodeDescriptor _
) As Integer
'Usage
 
Dim consumer As IEasySparkplugConsumer
Dim hostDescriptor As SparkplugHostDescriptor
Dim edgeNodeDescriptor As SparkplugEdgeNodeDescriptor
Dim value As Integer
 
value = IEasySparkplugConsumerExtension.SubscribeEdgeNodePayload(consumer, hostDescriptor, edgeNodeDescriptor)

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).

edgeNodeDescriptor
The Sparkplug edge node descriptor.

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

Return Value

Returns a payload 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 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.

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