'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Sub PublishDevicePayload( _
   ByVal consumer As IEasySparkplugConsumer, _
   ByVal deviceDescriptor As SparkplugDeviceDescriptor, _
   ByVal payload As SparkplugPayload _
) 

'Usage
 
Dim consumer As IEasySparkplugConsumer
Dim deviceDescriptor As SparkplugDeviceDescriptor
Dim payload As SparkplugPayload
 
IEasySparkplugConsumerExtension.PublishDevicePayload(consumer, deviceDescriptor, payload)

[Extension()]
public static void PublishDevicePayload( 
   IEasySparkplugConsumer consumer,
   SparkplugDeviceDescriptor deviceDescriptor,
   SparkplugPayload payload
)

[Extension()]
public:
static void PublishDevicePayload( 
   IEasySparkplugConsumer^ consumer,
   SparkplugDeviceDescriptor^ deviceDescriptor,
   SparkplugPayload^ payload
) 

Parameters

consumer

The consumer object that will perform the operation.

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

payload

The Sparkplug payload.

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

In Sparkplug terms, this method effectively sends the DCMD message to the device.

If there is an error publishing the payload, this method throws OpcLabs.EasySparkplug.OperationModel.SparkplugException.

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