// This example shows how to lock the publishing and obtain a disposable object which unlocks the publishing
// when it is disposed.
//
// 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 System.Threading;
using OpcLabs.EasySparkplug;
using Timer = System.Timers.Timer;
namespace SparkplugDocExamples.EdgeNode._EasySparkplugEdgeNode
{
class DisposableLockPublishing
{
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.
var edgeNode = new EasySparkplugEdgeNode(hostDescriptor, "easyGroup", "easySparkplugDemo");
// Configure the edge node so that we will publish data fully manually.
edgeNode.PublishingInterval = Timeout.Infinite;
edgeNode.ReportByException = true;
// Hook the SystemConnectionStateChanged event to handle system connection state changes.
edgeNode.SystemConnectionStateChanged += (sender, eventArgs) =>
{
// Display the new connection state (such as when the connection to the broker succeeds or fails).
Console.WriteLine($"{nameof(EasySparkplugEdgeNode.SystemConnectionStateChanged)}: {eventArgs}");
};
// Define metrics.
var random = new Random();
SparkplugMetric myMetric1 = SparkplugMetric.CreateIn(edgeNode, "MyMetric1").ValueType<int>();
SparkplugMetric myMetric2 = SparkplugMetric.CreateIn(edgeNode, "MyMetric2").ValueType<int>();
SparkplugMetric myMetric3 = SparkplugMetric.CreateIn(edgeNode, "MyMetric3").ValueType<int>();
// Start the edge node.
Console.WriteLine("The edge node is starting...");
edgeNode.Start();
Console.WriteLine("The edge node is started.");
Console.WriteLine();
// Create a timer for publishing the data, and start it.
var timer = new Timer { AutoReset = true };
timer.Elapsed += (sender, eventArgs) =>
{
// Lock/unlock the publishing so that we can make multiple updates without them being published immediately.
using (edgeNode.DisposableLockPublishing())
{
// Update some of the metrics (in this example, with random data).
if (random.Next(2) != 0)
myMetric1.UpdateReadData(random.Next());
if (random.Next(2) != 0)
myMetric2.UpdateReadData(random.Next());
if (random.Next(2) != 0)
myMetric3.UpdateReadData(random.Next());
// Upon leaving the 'using' block, the publishing will be unlocked, and any updated data published.
}
// Set the next interval to a random value between 0 and 3 seconds.
timer.Interval = random.Next(3 * 1000);
};
timer.Start();
// Let the user decide when to stop.
Console.WriteLine("Press Enter to stop the edge node...");
Console.ReadLine();
// Stop the timer.
timer.Stop();
// Stop the edge node.
Console.WriteLine("The edge node is stopping...");
edgeNode.Stop();
Console.WriteLine("The edge node is stopped.");
}
}
}
' This example shows how to lock the publishing and obtain a disposable object which unlocks the publishing
' when it is disposed.
'
' 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 System.Threading
Imports OpcLabs.EasySparkplug
Imports Timer = System.Timers.Timer
Namespace Global.SparkplugDocExamples.EdgeNode._EasySparkplugEdgeNode
Class DisposableLockPublishing
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.
Dim edgeNode = New EasySparkplugEdgeNode(hostDescriptor, "easyGroup", "easySparkplugDemo")
' Configure the edge node so that we will publish data fully manually.
edgeNode.PublishingInterval = Timeout.Infinite
edgeNode.ReportByException = True
' Hook the SystemConnectionStateChanged event to handle system connection state changes.
AddHandler edgeNode.SystemConnectionStateChanged,
Sub(sender, eventArgs)
' Display the new connection state (such as when the connection to the broker succeeds or fails).
Console.WriteLine($"{NameOf(EasySparkplugEdgeNode.SystemConnectionStateChanged)}: {eventArgs}")
End Sub
' Define metrics.
Dim random = New Random()
Dim myMetric1 As SparkplugMetric = SparkplugMetric.CreateIn(edgeNode, "MyMetric1").ValueType(Of Integer)()
Dim myMetric2 As SparkplugMetric = SparkplugMetric.CreateIn(edgeNode, "MyMetric2").ValueType(Of Integer)()
Dim myMetric3 As SparkplugMetric = SparkplugMetric.CreateIn(edgeNode, "MyMetric3").ValueType(Of Integer)()
' Start the edge node.
Console.WriteLine("The edge node is starting...")
edgeNode.Start()
Console.WriteLine("The edge node is started.")
Console.WriteLine()
' Create a timer for publishing the data, and start it.
Dim timer = New Timer() With {.AutoReset = True}
AddHandler timer.Elapsed,
Sub(sender, eventArgs)
' Lock/unlock the publishing so that we can make multiple updates without them being published immediately.
Using edgeNode.DisposableLockPublishing()
' Update some of the metrics (in this example, with random data).
If (random.Next(2) <> 0) Then
myMetric1.UpdateReadData(random.Next())
End If
If (random.Next(2) <> 0) Then
myMetric2.UpdateReadData(random.Next())
End If
If (random.Next(2) <> 0) Then
myMetric3.UpdateReadData(random.Next())
End If
' Upon leaving the 'using' block, the publishing will be unlocked, and any updated data published.
End Using
' Set the next interval to a random value between 0 and 3 seconds.
timer.Interval = random.Next(3 * 1000)
End Sub
timer.Start()
' Let the user decide when to stop.
Console.WriteLine("Press Enter to stop the edge node...")
Console.ReadLine()
' Stop the timer.
timer.Stop()
' Stop the edge node.
Console.WriteLine("The edge node is stopping...")
edgeNode.Stop()
Console.WriteLine("The edge node is stopped.")
End Sub
End Class
End Namespace