'DeclarationEvent SystemConnectionStateChanged As SparkplugConnectionStateChangedEventHandler
'UsageDim instance As ISparkplugSystemConnectionMonitoring Dim handler As SparkplugConnectionStateChangedEventHandler AddHandler instance.SystemConnectionStateChanged, handler
event SparkplugConnectionStateChangedEventHandler SystemConnectionStateChanged
event SparkplugConnectionStateChangedEventHandler^ SystemConnectionStateChanged
Event Data
The event handler receives an argument of type SparkplugConnectionStateChangedEventArgs containing data related to this event. The following SparkplugConnectionStateChangedEventArgs properties provide information specific to this event.
| Property | Description |
|---|---|
| ClientId | The client ID associated with this event. |
| ConnectionDescriptor | The Sparkplug connection descriptor associated with this event. |
| ConnectionState | Indicates the state of the connection. (Inherited from OpcLabs.BaseLib.Communication.ConnectedConditionChangedEventArgs) |
| 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) |
| 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) |
| IsConnected | Indicates whether the object is now connected. (Inherited from OpcLabs.BaseLib.Communication.ConnectedConditionChangedEventArgs) |
| 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) |
| RetrialDelay | When disconnected, contains time to next reconnection attempt. In milliseconds. (Inherited from OpcLabs.BaseLib.Communication.ConnectedConditionChangedEventArgs) |
| Statistics | Gets or sets statistics for the connected condition at the moment the event was generated. (Inherited from OpcLabs.BaseLib.Communication.ConnectedConditionChangedEventArgs) |
| StatusInfo | Status information corresponding to the contents of the event arguments. (Inherited from OpcLabs.BaseLib.Communication.ConnectedConditionChangedEventArgs) |
| Succeeded | Gets indication whether the operation has succeeded. (Inherited from OpcLabs.BaseLib.OperationModel.OperationEventArgs) |
Remarks
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.
Example
// This example shows how to create a Sparkplug edge node with a single metric, start and stop it. // // You can use any Sparkplug application, including our SparkplugCmd utility and the SparkplugApplicationConsoleDemo // program, to subscribe to the edge node data. // // Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-ConnectivityStudio/Latest/examples.html . // Sparkplug examples in C# on GitHub: https://github.com/OPCLabs/Examples-ConnectivityStudio-CSharp . // Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own // a commercial license in order to use Online Forums, and we reply to every post. using System; using OpcLabs.EasySparkplug; using OpcLabs.EasySparkplug.OperationModel; namespace SparkplugDocExamples.EdgeNode._EasySparkplugEdgeNode { partial class Start_Stop { static public void Main1() { // Note that the default port for the "mqtt" scheme is 1883. var hostDescriptor = new SparkplugHostDescriptor("mqtt://localhost"); // Instantiate the edge node object and hook events. var edgeNode = new EasySparkplugEdgeNode(hostDescriptor, "easyGroup", "easySparkplugDemo"); edgeNode.SystemConnectionStateChanged += edgeNode_Main1_SystemConnectionStateChanged; // Define a metric providing random integers. var random = new Random(); edgeNode.Metrics.Add(new SparkplugMetric("MyMetric").ReadValueFunction(() => random.Next())); // Start the edge node. Console.WriteLine("The edge node is starting..."); edgeNode.Start(); Console.WriteLine("The edge node is started."); Console.WriteLine(); // Let the user decide when to stop. Console.WriteLine("Press Enter to stop the edge node..."); Console.ReadLine(); // Stop the edge node. Console.WriteLine("The edge node is stopping..."); edgeNode.Stop(); Console.WriteLine("The edge node is stopped."); } static void edgeNode_Main1_SystemConnectionStateChanged( object sender, SparkplugConnectionStateChangedEventArgs eventArgs) { // Display the new connection state (such as when the connection to the broker succeeds or fails). Console.WriteLine($"{nameof(EasySparkplugEdgeNode.SystemConnectionStateChanged)}: {eventArgs}"); } } }
' This example shows how to create a Sparkplug edge node with a single metric, start and stop it. ' ' You can use any Sparkplug application, including our SparkplugCmd utility and the SparkplugApplicationConsoleDemo ' program, to subscribe to the edge node data. ' ' Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-ConnectivityStudio/Latest/examples.html . ' Sparkplug examples in C# on GitHub: https://github.com/OPCLabs/Examples-ConnectivityStudio-CSharp . ' Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own ' a commercial license in order to use Online Forums, and we reply to every post. Imports OpcLabs.EasySparkplug Imports OpcLabs.EasySparkplug.OperationModel Namespace Global.SparkplugDocExamples.EdgeNode._EasySparkplugEdgeNode Partial Class Start_Stop Public Shared Sub Main1() ' Note that the default port for the "mqtt" scheme is 1883. Dim hostDescriptor = New SparkplugHostDescriptor("mqtt://localhost") ' Instantiate the edge node object and hook events. Dim edgeNode = New EasySparkplugEdgeNode(hostDescriptor, "easyGroup", "easySparkplugDemo") AddHandler edgeNode.SystemConnectionStateChanged, AddressOf edgeNode_Main1_SystemConnectionStateChanged ' Define a metric providing random integers. Dim random = New Random() edgeNode.Metrics.Add(New SparkplugMetric("MyMetric").ReadValueFunction(Function() random.Next())) ' Start the edge node. Console.WriteLine("The edge node is starting...") edgeNode.Start() Console.WriteLine("The edge node is started.") Console.WriteLine() ' Let the user decide when to stop. Console.WriteLine("Press Enter to stop the edge node...") Console.ReadLine() ' Stop the edge node. Console.WriteLine("The edge node is stopping...") edgeNode.Stop() Console.WriteLine("The edge node is stopped.") End Sub Private Shared Sub edgeNode_Main1_SystemConnectionStateChanged _ (ByVal sender As Object, ByVal eventArgs As SparkplugConnectionStateChangedEventArgs) ' Display the new connection state (such as when the connection to the broker succeeds or fails). Console.WriteLine($"{NameOf(EasySparkplugEdgeNode.SystemConnectionStateChanged)}: {eventArgs}") End Sub End Class End Namespace
Requirements