CriticalSection

From Xojo Documentation

Revision as of 18:55, 19 November 2009 by WikiSysop (talk) (1 revision)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)


Description

Used to protect a resource in a multithreaded environment.


Super Class

Object

Methods

Name Parameters Return Type Description
Enter Attempts to get a lock on the resource managed by the CriticalSection.

When the call to Enter succeeds, the function returns and your code has exclusive access to the protected resource. If the lock cannot be obtained immediately, Enter will block the current thread from continuing to run. It will wait for the resource to become available. Enter differs from the Signal method of the Semaphore class in that it can be called multiple times from the currently executing thread. If the calling thread already owns the lock, the method returns immediately. This makes CriticalSections very useful for calling a method recursively.

Leave Call Leave when you are finished using the protected resource and you want to give it back to the CriticalSection.

Every time you call Enter or TryEnter and succeed, you must call Leave. This includes calling it recursively. Otherwise the resource will be protected indefinitely.

TryEnter Boolean Attempts to get a lock on the resource managed by the CriticalSection.

TryEnter is similar to Enter but returns a Boolean. If it succeeds, it returns True and the thread has exclusive use of the resource. If it fails, it returns False but does not block execution of the thread.


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. The Mutex class is similar to a CriticalSection, but its scope is all the applications that are running on the user's computer, not just the current REALbasic application. You can use a Mutex, for example, check whether another copy of the application is running and is using a needed 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 window 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.


See Also

Mutex, Semaphore, Thread classes.