Export (0) Print
Expand All

WaitHandle.SignalAndWait Method (WaitHandle, WaitHandle, TimeSpan, Boolean)

Updated: April 2011

Signals one wait handle and waits on another, specifying the time-out interval as a TimeSpan and specifying whether to exit the synchronization domain for the context before entering the wait.

Namespace:  System.Threading
Assembly:  mscorlib (in mscorlib.dll)

public static bool SignalAndWait(
	WaitHandle toSignal,
	WaitHandle toWaitOn,
	TimeSpan timeout,
	bool exitContext
)

Parameters

toSignal
Type: System.Threading.WaitHandle

The wait handle to signal.

toWaitOn
Type: System.Threading.WaitHandle

The wait handle to wait on.

timeout
Type: System.TimeSpan

The interval to wait. If the value is -1, the wait is infinite.

exitContext
Type: System.Boolean

true to exit the synchronization domain for the context before the wait (if in a synchronized context), and reacquire it afterward; otherwise, false.

Return Value

Type: System.Boolean
true if both the signal and the wait completed successfully, or false if the signal completed but the wait timed out.

ExceptionCondition
ArgumentNullException

toSignal is null.

-or-

toWaitOn is null.

NotSupportedException

The method was called on a thread that has STAThreadAttribute.

PlatformNotSupportedException

This method is not supported on Windows 98 or Windows Millennium Edition.

InvalidOperationException

toSignal is a semaphore, and it already has a full count.

ArgumentOutOfRangeException

timeout evaluates to a negative number of milliseconds other than -1.

-or-

timeout is greater than Int32.MaxValue.

AbandonedMutexException

The wait completed because a thread exited without releasing a mutex. This exception is not thrown on Windows 98 or Windows Millennium Edition.

This operation is not guaranteed to be atomic. After the current thread signals toSignal but before it waits on toWaitOn, a thread that is running on another processor might signal toWaitOn or wait on it.

The maximum value for timeout is Int32.MaxValue.

If timeout is zero, the method does not block. It tests the state of the toWaitOn and returns immediately.

Notes on Exiting the Context

The exitContext parameter has no effect unless the SignalAndWait method is called from inside a nondefault managed context. This can happen if your thread is inside a call to an instance of a class derived from ContextBoundObject. Even if you are currently executing a method on a class that does not derive from ContextBoundObject, like String, you can be in a nondefault context if a ContextBoundObject is on your stack in the current application domain.

When your code is executing in a nondefault context, specifying true for exitContext causes the thread to exit the nondefault managed context (that is, to transition to the default context) before executing the SignalAndWait method. The thread returns to the original nondefault context after the call to the SignalAndWait method completes.

This can be useful when the context-bound class has SynchronizationAttribute. In that case, all calls to members of the class are automatically synchronized, and the synchronization domain is the entire body of code for the class. If code in the call stack of a member calls the SignalAndWait method and specifies true for exitContext, the thread exits the synchronization domain, allowing a thread that is blocked on a call to any member of the object to proceed. When the SignalAndWait method returns, the thread that made the call must wait to reenter the synchronization domain.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

Date

History

Reason

April 2011

Correction: The operation is not atomic.

Customer feedback.

Community Additions

ADD
Show:
© 2014 Microsoft