PublishPayload Method (EasySparkplugConsumerCore)

Publishes the specified payload to the Sparkplug system.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Sub PublishPayload( _
   ByVal payloadPublicationArguments As SparkplugPayloadPublicationArguments _
)

'Usage
 
Dim instance As EasySparkplugConsumerCore
Dim payloadPublicationArguments As SparkplugPayloadPublicationArguments
 
instance.PublishPayload(payloadPublicationArguments)

public void PublishPayload( 
   SparkplugPayloadPublicationArguments payloadPublicationArguments
)

public:
void PublishPayload( 
   SparkplugPayloadPublicationArguments^ payloadPublicationArguments
)

Parameters

payloadPublicationArguments: The Sparkplug payload publication arguments.
The value of this parameter cannot be null (Nothing in Visual Basic).

Exceptions

Exception Description

System.ObjectDisposedException An operation was performed on a disposed object.

Exception	Description
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.
OpcLabs.EasySparkplug.OperationModel.SparkplugException	The Sparkplug operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

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.

OpcLabs.EasySparkplug.OperationModel.SparkplugException

The Sparkplug operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

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

The IEasySparkplugConsumerExtension class contains several PublishXXXXPayload and PublishXXXXMetric extension methods that build on top of this method, and can be used to publish Sparkplug commands without constructing the OpcLabs.EasySparkplug.OperationModel.SparkplugPayloadPublicationArguments object for the payloadPublicationArguments.

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

EasySparkplugConsumerCore Class
EasySparkplugConsumerCore 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.