The value of this parameter cannot be null (Nothing in Visual Basic).
'DeclarationPublic Sub PublishDataPayload( _ ByVal payload As SparkplugPayload _ )
'UsageDim instance As SparkplugDevice Dim payload As SparkplugPayload instance.PublishDataPayload(payload)
public void PublishDataPayload( SparkplugPayload payload )
public: void PublishDataPayload( SparkplugPayload^ payload )
The value of this parameter cannot be null (Nothing in Visual Basic).
| Exception | Description |
|---|---|
| System.InvalidOperationException | A method call was invalid for the object's current state. 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. |
In the default configuration, when ReportByException is false, your code does not call this method directly. Instead, it is called for you with the data collected by polling. You would typically call this method when you set ReportByException to true, and then take care of all data publishing.
If the payload is empty (contains no payload elements), no message is published.
Error that occur during publishing are reported through the ISparkplugProducerEvents.PublishingError event. This includes an error when publishing is attempted while the producer is offline (ProducerOnline is false).
The producer must be started, otherwise System.InvalidOperationException is thrown.
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.