'DeclarationEvent PayloadNotification As EasySparkplugPayloadNotificationEventHandler
'UsageDim instance As IEasySparkplugNotificationEvents Dim handler As EasySparkplugPayloadNotificationEventHandler AddHandler instance.PayloadNotification, handler
event EasySparkplugPayloadNotificationEventHandler PayloadNotification
event EasySparkplugPayloadNotificationEventHandler^ PayloadNotification
The event handler receives an argument of type EasySparkplugPayloadNotificationEventArgs containing data related to this event. The following EasySparkplugPayloadNotificationEventArgs properties provide information specific to this event.
| Property | Description |
|---|---|
| Arguments | The Sparkplug payload subscription arguments of the subscription that generated this notification. |
| ClientId | The client ID (of the broker connection) associated with this notification. (Inherited from OpcLabs.EasySparkplug.OperationModel.EasySparkplugNotificationEventArgs) |
| ComponentTypes | The Sparkplug component types associated with this notification. (Inherited from OpcLabs.EasySparkplug.OperationModel.EasySparkplugNotificationEventArgs) |
| DeviceId | The Sparkplug device ID associated with this notification. (Inherited from OpcLabs.EasySparkplug.OperationModel.EasySparkplugNotificationEventArgs) |
| Diagnostics | Diagnostics information (such as warnings) assembled during the operation. (Inherited from OpcLabs.BaseLib.OperationModel.OperationEventArgs) |
| DiagnosticsCount | Count of diagnostic information elements assembled during the operation. (Inherited from OpcLabs.BaseLib.OperationModel.OperationEventArgs) |
| DiagnosticsSummary | Textual summary of diagnostics information, one message per line. (Inherited from OpcLabs.BaseLib.OperationModel.OperationEventArgs) |
| EdgeNodeId | The Sparkplug edge node ID associated with this notification. (Inherited from OpcLabs.EasySparkplug.OperationModel.EasySparkplugNotificationEventArgs) |
| ErrorId | Gets or sets the error ID of the error. (Inherited from OpcLabs.BaseLib.OperationModel.OperationEventArgs) |
| ErrorMessage | Gets or sets a message that describes the current exception. (Inherited from OpcLabs.BaseLib.OperationModel.OperationEventArgs) |
| ErrorMessageBrief | The first line of the error message. (Inherited from OpcLabs.BaseLib.OperationModel.OperationEventArgs) |
| Exception | Gets the current exception. Contains null reference when no exception. (Inherited from OpcLabs.BaseLib.OperationModel.OperationEventArgs) |
| GroupId | The Sparkplug group ID associated with this notification. (Inherited from OpcLabs.EasySparkplug.OperationModel.EasySparkplugNotificationEventArgs) |
| HasData | Determines whether this notification delivers data with it. (Inherited from OpcLabs.EasySparkplug.OperationModel.EasySparkplugNotificationEventArgs) |
| IsSynthesized | Indicates whether the notification is synthesized. (Inherited from OpcLabs.EasySparkplug.OperationModel.EasySparkplugNotificationEventArgs) |
| NormalizedDiagnostics | A normalized OpcLabs.BaseLib.OperationModel.OperationEventArgs.Diagnostics collection. (Inherited from OpcLabs.BaseLib.OperationModel.OperationEventArgs) |
| NormalizedException | A normalized OpcLabs.BaseLib.OperationModel.OperationEventArgs.Exception object, or null if there was no error. (Inherited from OpcLabs.BaseLib.OperationModel.OperationEventArgs) |
| NotificationType | The Sparkplug notification type of this notification. (Inherited from OpcLabs.EasySparkplug.OperationModel.EasySparkplugNotificationEventArgs) |
| Payload | The payload delivered by this notification, if available. |
| Succeeded | Gets indication whether the operation has succeeded. (Inherited from OpcLabs.BaseLib.OperationModel.OperationEventArgs) |
| SystemDescriptor | The effective Sparkplug system descriptor of the component that generated the notification. (Inherited from OpcLabs.EasySparkplug.OperationModel.EasySparkplugNotificationEventArgs) |
On the Device (SparkplugDevice), this event is raised when a device command (DCMD) is received from the Host Application. On the Edge Node (EasySparkplugEdgeNodeCore), this event is raised when an edge node command (NCMD) is received from the Host Application, and also for all commands received by the devices that belong to the edge node. You can use the OpcLabs.EasySparkplug.OperationModel.EasySparkplugNotificationEventArgs.ComponentTypes property to distinguish between the device and edge node commands.
On the consumer (EasySparkplugConsumerCore), this event is raised for payloads subscribed through the IEasySparkplugConsumer.SubscribePayload method (or extension methods that rely on it).
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.