SignalAndWait Method (TimeSpan, CancellationToken)

Task Parallel System.Threading

previous page next page

Signals that a participant has reached the Barrier and waits for all other participants to reach the barrier as well, using a TimeSpan to measure the time interval, while observing a CancellationToken.

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

Syntax

Visual Basic (Declaration)
Public Function SignalAndWait ( _
	timeout As TimeSpan, _
	cancellationToken As CancellationToken _
) As Boolean
C#
public bool SignalAndWait(
	TimeSpan timeout,
	CancellationToken cancellationToken
)

Parameters

timeout
Type: System..::.TimeSpan
A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.
cancellationToken
Type: System.Threading..::.CancellationToken
The CancellationToken to observe.

Return Value

true if all other participants reached the barrier; otherwise, false.

Exceptions

ExceptionCondition
System..::.ArgumentOutOfRangeExceptiontimeoutis a negative number other than -1 milliseconds, which represents an infinite time-out.
System..::.InvalidOperationException The method was invoked from within a post-phase action, the barrier currently has 0 participants, or the barrier is being used by more threads than are registered as participants.
System..::.OperationCanceledExceptioncancellationToken has been canceled.
System..::.ObjectDisposedExceptionThe current instance has already been disposed.

See Also

previous page start next page