Connectivity Software User's Guide and Reference
Freeze Method (SparkplugDevice)



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace > SparkplugDevice Class : Freeze Method
Freezes the device, preventing it from being considered alive.
Syntax
'Declaration
 
Public Sub Freeze() 
'Usage
 
Dim instance As SparkplugDevice
 
instance.Freeze()
public void Freeze()
public:
void Freeze(); 
Exceptions
ExceptionDescription
An operation was performed on a disposed object.
Remarks

Freezing a device can be used to force it to publish a death message; this mechanism is internally used by the ISparkplugDeviceExtension.PerformRebirth method. You will rarely need to freeze a device from your own code for other purposes.

The calls to Freeze and Thaw must be paired; the device keep an internal freeze count, and is frozen whenever the freeze count is not zero.

You can use the IsFrozen property to determine whether the device is currently frozen.

 

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

See Also