Guard Class
Used to lock and unlock the global configuration lock or an ILockable.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public class Guard : System.Object, System.IDisposableRemarks
The Guard class is used to synchronize access to the configuration, MemoryDataSet instances and ICustomDataSet implementations. The constructor used to instantiate a Guard determines which lock will be used.
To synchronize access to data in an ICustomDataSet implementation you instantiate a Guard with the CustomDataSetContext that was passed to the custom object when it was initialized in the ICustomDataSet.initNew method.
The .NET version of the Guard class implements the IDisposable interface and releases the lock when the Guard is disposed.
The lock will also be released when the Guard is finalized but an application should not rely on the finalizer to release the lock in a timely fashion because the CLR is free to schedule object finalization at any time, including long after the last reference to the Guard has been released.
More information can be found in Carmenta Engine Threading Model.
See Carmenta Engine Threading Model for more details.
Example
// Use a Guard to lock the configuraton or a MemoryDataSet
public static void LockingConfigurationOrDataSet(MemoryDataSet dataSet)
{
// Take the global configuration lock
using (Guard guard = new Guard())
{
// Now it is safe to make modification to the configuration
} // The lock is automatically released when guard is disposed
// Lock a memory dataset while inserting a feature
Feature feature = new Feature(new PointGeometry(0, 0), dataSet.Crs);
using (Guard guard = new Guard(dataSet))
{
dataSet.Insert(feature);
} // The lock is automatically released when guard is disposed
}Inheritance Hierarchy
System.Object (not available in C#)
Guard
Platforms
Windows, Linux, Android
Guard Members
The Guard type has the following members.
Constructors
| Name | Description |
|---|---|
| Guard | Initializes a new instance of the Guard class. |
Methods
| Name | Description |
|---|