View source for Xojo.Threading.CriticalSection

{{Deprecated | version=2020r2 | replacement=[[CriticalSection]]}}
{{ClassBox
| super=[[Object]]
| scope=global
}}
{{Description
| text=Used to protect a single resource in a multithreaded environment.}}

<dynamicTable id="Methods" class="methodTable" title="Methods" columns="3">
{{Method | name=Enter | description=Enter&#10;Attempts to get a lock on the resource managed by the CriticalSection.}}
{{Method | name=Leave | description=Leave&#10;Call Leave when you are finished using the protected resource and you want to give it back to the CriticalSection.}}
{{Method | name=TryEnter | description=TryEnter As Boolean&#10;Attempts to get a lock on the resource managed by the CriticalSection without blocking the app.}}
</dynamicTable>

== Notes ==
A CriticalSection is similar to a Semaphore, except a CriticalSection protects only one resource. The Semaphore class, on the other hand, can protect more than one resource.

You use critical sections in conjunction with Threads. In a situation in which two or more of the threads might try to access the same item, then you should enclose the code with calls to the Enter (or TryEnter) and Leave methods.

One strategy is this:
* Create a subclass of Thread which does the operations that might compete for access to a resource.
* Create a CriticalSection property of Public scope in, for example, the View that contains the control that calls the threads.
* In the Run event handler of the Thread, call Enter and Leave before and after the code that tries to access the shared resource.

If a thread that has a lock crashes, the lock is not released.

== Sample Code ==
For example, if you have a logging file that multiple threads are writing to you may want to ensure that only a single thread has the file open for writing at one time. You could do this by having a WriteLog method that opens the file if it can get the lock. A property called LogFileAvailable As CriticalSection is initialized by the thread:
<rbcode>
LogFileAvailable = New CriticalSection
</rbcode>
And then a method can check it before it attempts to open the log file for writing:
<rbcode>
Sub LogInfo(logText As Text)
  If LogFileAvailable.TryEnter Then
    Var file As FolderItem = SpecialFolder.Documents.("log.txt")
    file = TextOutputStream.Open(file, Encodings.UTF8)
    file.WriteLine(logText)
    file.Close
    LogFileAvailable.Leave
  End If
End Sub
</rbcode>

== See Also ==
[[Xojo.Threading.Semaphore]], [[Xojo.Threading.Thread]] classes

[[Category:iOS]]