ManualResetEventSlim.Wait Method

Definition

Blocks the current thread until the current ManualResetEventSlim is set.

Overloads

Wait()

Blocks the current thread until the current ManualResetEventSlim is set.

Wait(Int32)

Blocks the current thread until the current ManualResetEventSlim is set, using a 32-bit signed integer to measure the time interval.

Wait(CancellationToken)

Blocks the current thread until the current ManualResetEventSlim receives a signal, while observing a CancellationToken.

Wait(TimeSpan)

Blocks the current thread until the current ManualResetEventSlim is set, using a TimeSpan to measure the time interval.

Wait(Int32, CancellationToken)

Blocks the current thread until the current ManualResetEventSlim is set, using a 32-bit signed integer to measure the time interval, while observing a CancellationToken.

Wait(TimeSpan, CancellationToken)

Blocks the current thread until the current ManualResetEventSlim is set, using a TimeSpan to measure the time interval, while observing a CancellationToken.

Wait()

Blocks the current thread until the current ManualResetEventSlim is set.

public:
 void Wait();
public void Wait ();
member this.Wait : unit -> unit
Public Sub Wait ()

Exceptions

The maximum number of waiters has been exceeded.

The object has already been disposed.

Remarks

The caller of this method blocks indefinitely until the current instance is set. The caller will return immediately if the event is currently in a set state.

See also

Applies to

Wait(Int32)

Blocks the current thread until the current ManualResetEventSlim is set, using a 32-bit signed integer to measure the time interval.

public:
 bool Wait(int millisecondsTimeout);
public bool Wait (int millisecondsTimeout);
member this.Wait : int -> bool
Public Function Wait (millisecondsTimeout As Integer) As Boolean

Parameters

millisecondsTimeout
Int32

The number of milliseconds to wait, or Infinite(-1) to wait indefinitely.

Returns

Boolean

true if the ManualResetEventSlim was set; otherwise, false.

Exceptions

millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.

The maximum number of waiters has been exceeded.

The object has already been disposed.

See also

Applies to

Wait(CancellationToken)

Blocks the current thread until the current ManualResetEventSlim receives a signal, while observing a CancellationToken.

public:
 void Wait(System::Threading::CancellationToken cancellationToken);
public void Wait (System.Threading.CancellationToken cancellationToken);
member this.Wait : System.Threading.CancellationToken -> unit
Public Sub Wait (cancellationToken As CancellationToken)

Parameters

cancellationToken
CancellationToken

The CancellationToken to observe.

Exceptions

The maximum number of waiters has been exceeded.

cancellationToken was canceled.

The object has already been disposed or the CancellationTokenSource that created cancellationToken has been disposed.

cancellationToken was canceled.

Remarks

The caller of this method blocks indefinitely until the current instance is set. The caller will return immediately if the event is currently in a set state.

See also

Applies to

Wait(TimeSpan)

Blocks the current thread until the current ManualResetEventSlim is set, using a TimeSpan to measure the time interval.

public:
 bool Wait(TimeSpan timeout);
public bool Wait (TimeSpan timeout);
member this.Wait : TimeSpan -> bool
Public Function Wait (timeout As TimeSpan) As Boolean

Parameters

timeout
TimeSpan

A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.

Returns

Boolean

true if the ManualResetEventSlim was set; otherwise, false.

Exceptions

timeout is a negative number other than -1 milliseconds, which represents an infinite time-out.

-or-

The number of milliseconds in timeout is greater than MaxValue.

The maximum number of waiters has been exceeded.

The object has already been disposed.

See also

Applies to

Wait(Int32, CancellationToken)

Blocks the current thread until the current ManualResetEventSlim is set, using a 32-bit signed integer to measure the time interval, while observing a CancellationToken.

public:
 bool Wait(int millisecondsTimeout, System::Threading::CancellationToken cancellationToken);
public bool Wait (int millisecondsTimeout, System.Threading.CancellationToken cancellationToken);
member this.Wait : int * System.Threading.CancellationToken -> bool
Public Function Wait (millisecondsTimeout As Integer, cancellationToken As CancellationToken) As Boolean

Parameters

millisecondsTimeout
Int32

The number of milliseconds to wait, or Infinite(-1) to wait indefinitely.

cancellationToken
CancellationToken

The CancellationToken to observe.

Returns

Boolean

true if the ManualResetEventSlim was set; otherwise, false.

Exceptions

millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.

The maximum number of waiters has been exceeded.

The object has already been disposed or the CancellationTokenSource that created cancellationToken has been disposed.

cancellationToken was canceled.

See also

Applies to

Wait(TimeSpan, CancellationToken)

Blocks the current thread until the current ManualResetEventSlim is set, using a TimeSpan to measure the time interval, while observing a CancellationToken.

public:
 bool Wait(TimeSpan timeout, System::Threading::CancellationToken cancellationToken);
public bool Wait (TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.Wait : TimeSpan * System.Threading.CancellationToken -> bool
Public Function Wait (timeout As TimeSpan, cancellationToken As CancellationToken) As Boolean

Parameters

timeout
TimeSpan

A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.

cancellationToken
CancellationToken

The CancellationToken to observe.

Returns

Boolean

true if the ManualResetEventSlim was set; otherwise, false.

Exceptions

timeout is a negative number other than -1 milliseconds, which represents an infinite time-out.

-or-

The number of milliseconds in timeout is greater than MaxValue.

The maximum number of waiters has been exceeded.

The object has already been disposed or the CancellationTokenSource that created cancellationToken has been disposed.

cancellationToken was canceled.

See also

Applies to