</member>
<member name="M:System.Threading.AsyncFlowControl.Dispose">
<summary>Releases all resources used by the current instance of the <see cref="T:System.Threading.AsyncFlowControl" /> class.</summary>
- <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Threading.AsyncFlowControl" /> structure is not used on the thread where it was created.
-
- -or-
-
- The <see cref="T:System.Threading.AsyncFlowControl" /> structure has already been used to call <see cref="M:System.Threading.AsyncFlowControl.Dispose" /> or <see cref="M:System.Threading.AsyncFlowControl.Undo" />.</exception>
+ <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Threading.AsyncFlowControl" /> structure is not used on the thread where it was created.
+-or-
+The <see cref="T:System.Threading.AsyncFlowControl" /> structure has already been used to call <see cref="M:System.Threading.AsyncFlowControl.Dispose" /> or <see cref="M:System.Threading.AsyncFlowControl.Undo" />.</exception>
</member>
<member name="M:System.Threading.AsyncFlowControl.Equals(System.Object)">
<summary>Determines whether the specified object is equal to the current <see cref="T:System.Threading.AsyncFlowControl" /> structure.</summary>
</member>
<member name="M:System.Threading.AsyncFlowControl.Undo">
<summary>Restores the flow of the execution context between threads.</summary>
- <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Threading.AsyncFlowControl" /> structure is not used on the thread where it was created.
-
- -or-
-
- The <see cref="T:System.Threading.AsyncFlowControl" /> structure has already been used to call <see cref="M:System.Threading.AsyncFlowControl.Dispose" /> or <see cref="M:System.Threading.AsyncFlowControl.Undo" />.</exception>
+ <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Threading.AsyncFlowControl" /> structure is not used on the thread where it was created.
+-or-
+The <see cref="T:System.Threading.AsyncFlowControl" /> structure has already been used to call <see cref="M:System.Threading.AsyncFlowControl.Dispose" /> or <see cref="M:System.Threading.AsyncFlowControl.Undo" />.</exception>
</member>
<member name="T:System.Threading.AsyncLocal`1">
<summary>Represents ambient data that is local to a given asynchronous control flow, such as an asynchronous method.</summary>
</member>
<member name="M:System.Threading.Barrier.AddParticipant">
<summary>Notifies the <see cref="T:System.Threading.Barrier" /> that there will be an additional participant.</summary>
- <exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
- <exception cref="T:System.InvalidOperationException">Adding a participant would cause the barrier's participant count to exceed 32,767.
-
- -or-
-
- The method was invoked from within a post-phase action.</exception>
<returns>The phase number of the barrier in which the new participants will first participate.</returns>
+ <exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
+ <exception cref="T:System.InvalidOperationException">Adding a participant would cause the barrier's participant count to exceed 32,767.
+-or-
+The method was invoked from within a post-phase action.</exception>
</member>
<member name="M:System.Threading.Barrier.AddParticipants(System.Int32)">
<summary>Notifies the <see cref="T:System.Threading.Barrier" /> that there will be additional participants.</summary>
<param name="participantCount">The number of additional participants to add to the barrier.</param>
+ <returns>The phase number of the barrier in which the new participants will first participate.</returns>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="participantCount" /> is less than 0.
-
- -or-
-
- Adding <paramref name="participantCount" /> participants would cause the barrier's participant count to exceed 32,767.</exception>
+ <paramref name="participantCount" /> is less than 0.
+-or-
+Adding <paramref name="participantCount" /> participants would cause the barrier's participant count to exceed 32,767.</exception>
<exception cref="T:System.InvalidOperationException">The method was invoked from within a post-phase action.</exception>
- <returns>The phase number of the barrier in which the new participants will first participate.</returns>
+ </member>
+ <member name="P:System.Threading.Barrier.CurrentPhaseNumber">
+ <summary>Gets the number of the barrier's current phase.</summary>
+ <returns>Returns the number of the barrier's current phase.</returns>
</member>
<member name="M:System.Threading.Barrier.Dispose">
<summary>Releases all resources used by the current instance of the <see cref="T:System.Threading.Barrier" /> class.</summary>
<summary>Releases the unmanaged resources used by the <see cref="T:System.Threading.Barrier" />, and optionally releases the managed resources.</summary>
<param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
</member>
+ <member name="P:System.Threading.Barrier.ParticipantCount">
+ <summary>Gets the total number of participants in the barrier.</summary>
+ <returns>Returns the total number of participants in the barrier.</returns>
+ </member>
+ <member name="P:System.Threading.Barrier.ParticipantsRemaining">
+ <summary>Gets the number of participants in the barrier that haven't yet signaled in the current phase.</summary>
+ <returns>Returns the number of participants in the barrier that haven't yet signaled in the current phase.</returns>
+ </member>
<member name="M:System.Threading.Barrier.RemoveParticipant">
<summary>Notifies the <see cref="T:System.Threading.Barrier" /> that there will be one less participant.</summary>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
- <exception cref="T:System.InvalidOperationException">The barrier already has 0 participants.
-
- -or-
-
- The method was invoked from within a post-phase action.</exception>
+ <exception cref="T:System.InvalidOperationException">The barrier already has 0 participants.
+-or-
+The method was invoked from within a post-phase action.</exception>
</member>
<member name="M:System.Threading.Barrier.RemoveParticipants(System.Int32)">
<summary>Notifies the <see cref="T:System.Threading.Barrier" /> that there will be fewer participants.</summary>
<param name="participantCount">The number of additional participants to remove from the barrier.</param>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The total participant count is less than the specified <paramref name="participantCount" /></exception>
- <exception cref="T:System.InvalidOperationException">The barrier already has 0 participants.
-
- -or-
-
- The method was invoked from within a post-phase action.
-
- -or-
-
- The current participant count is less than the specified participantCount.</exception>
+ <exception cref="T:System.InvalidOperationException">The barrier already has 0 participants.
+-or-
+The method was invoked from within a post-phase action.
+-or-
+current participant count is less than the specified participantCount</exception>
</member>
<member name="M:System.Threading.Barrier.SignalAndWait">
<summary>Signals that a participant has reached the barrier and waits for all other participants to reach the barrier as well.</summary>
<member name="M:System.Threading.Barrier.SignalAndWait(System.Int32)">
<summary>Signals that a participant has reached the barrier and waits for all other participants to reach the barrier as well, using a 32-bit signed integer to measure the timeout.</summary>
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" />(-1) to wait indefinitely.</param>
+ <returns>
+ <see langword="true" /> if all participants reached the barrier within the specified time; otherwise <see langword="false" />.</returns>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.</exception>
<exception cref="T:System.InvalidOperationException">The method was invoked from within a post-phase action, the barrier currently has 0 participants, or the barrier is signaled by more threads than are registered as participants.</exception>
<exception cref="T:System.Threading.BarrierPostPhaseException">If an exception is thrown from the post phase action of a Barrier after all participating threads have called SignalAndWait, the exception will be wrapped in a BarrierPostPhaseException and be thrown on all participating threads.</exception>
- <returns>
- <see langword="true" /> if all participants reached the barrier within the specified time; otherwise <see langword="false" />.</returns>
</member>
<member name="M:System.Threading.Barrier.SignalAndWait(System.Int32,System.Threading.CancellationToken)">
<summary>Signals that a participant has reached the barrier and waits for all other participants to reach the barrier as well, using a 32-bit signed integer to measure the timeout, while observing a cancellation token.</summary>
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" />(-1) to wait indefinitely.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to observe.</param>
+ <returns>if all participants reached the barrier within the specified time; otherwise false</returns>
<exception cref="T:System.OperationCanceledException">
<paramref name="cancellationToken" /> has been canceled.</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.</exception>
<exception cref="T:System.InvalidOperationException">The method was invoked from within a post-phase action, the barrier currently has 0 participants, or the barrier is signaled by more threads than are registered as participants.</exception>
- <returns>
- <see langword="true" /> if all participants reached the barrier within the specified time; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Threading.Barrier.SignalAndWait(System.Threading.CancellationToken)">
<summary>Signals that a participant has reached the barrier and waits for all other participants to reach the barrier, while observing a cancellation token.</summary>
<member name="M:System.Threading.Barrier.SignalAndWait(System.TimeSpan)">
<summary>Signals that a participant has reached the barrier and waits for all other participants to reach the barrier as well, using a <see cref="T:System.TimeSpan" /> object to measure the time interval.</summary>
<param name="timeout">A <see cref="T:System.TimeSpan" /> that represents the number of milliseconds to wait, or a <see cref="T:System.TimeSpan" /> that represents -1 milliseconds to wait indefinitely.</param>
+ <returns>
+ <see langword="true" /> if all other participants reached the barrier; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="timeout" /> is a negative number other than -1 milliseconds, which represents an infinite time-out, or it is greater than 32,767.</exception>
<exception cref="T:System.InvalidOperationException">The method was invoked from within a post-phase action, the barrier currently has 0 participants, or the barrier is signaled by more threads than are registered as participants.</exception>
- <returns>
- <see langword="true" /> if all other participants reached the barrier; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Threading.Barrier.SignalAndWait(System.TimeSpan,System.Threading.CancellationToken)">
<summary>Signals that a participant has reached the barrier and waits for all other participants to reach the barrier as well, using a <see cref="T:System.TimeSpan" /> object to measure the time interval, while observing a cancellation token.</summary>
<param name="timeout">A <see cref="T:System.TimeSpan" /> that represents the number of milliseconds to wait, or a <see cref="T:System.TimeSpan" /> that represents -1 milliseconds to wait indefinitely.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to observe.</param>
+ <returns>
+ <see langword="true" /> if all other participants reached the barrier; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.OperationCanceledException">
<paramref name="cancellationToken" /> has been canceled.</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="timeout" /> is a negative number other than -1 milliseconds, which represents an infinite time-out.</exception>
<exception cref="T:System.InvalidOperationException">The method was invoked from within a post-phase action, the barrier currently has 0 participants, or the barrier is signaled by more threads than are registered as participants.</exception>
- <returns>
- <see langword="true" /> if all other participants reached the barrier; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Threading.Barrier.CurrentPhaseNumber">
- <summary>Gets the number of the barrier's current phase.</summary>
- <returns>Returns the number of the barrier's current phase.</returns>
- </member>
- <member name="P:System.Threading.Barrier.ParticipantCount">
- <summary>Gets the total number of participants in the barrier.</summary>
- <returns>Returns the total number of participants in the barrier.</returns>
- </member>
- <member name="P:System.Threading.Barrier.ParticipantsRemaining">
- <summary>Gets the number of participants in the barrier that haven't yet signaled in the current phase.</summary>
- <returns>Returns the number of participants in the barrier that haven't yet signaled in the current phase.</returns>
</member>
<member name="T:System.Threading.BarrierPostPhaseException">
<summary>The exception that is thrown when the post-phase action of a <see cref="T:System.Threading.Barrier" /> fails.</summary>
<member name="M:System.Threading.CountdownEvent.AddCount">
<summary>Increments the <see cref="T:System.Threading.CountdownEvent" />'s current count by one.</summary>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
- <exception cref="T:System.InvalidOperationException">The current instance is already set.
-
- -or-
-
- <see cref="P:System.Threading.CountdownEvent.CurrentCount" /> is equal to or greater than <see cref="F:System.Int32.MaxValue" />.</exception>
+ <exception cref="T:System.InvalidOperationException">The current instance is already set.
+-or-
+<see cref="P:System.Threading.CountdownEvent.CurrentCount" /> is equal to or greater than <see cref="F:System.Int32.MaxValue" />.</exception>
</member>
<member name="M:System.Threading.CountdownEvent.AddCount(System.Int32)">
<summary>Increments the <see cref="T:System.Threading.CountdownEvent" />'s current count by a specified value.</summary>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="signalCount" /> is less than or equal to 0.</exception>
- <exception cref="T:System.InvalidOperationException">The current instance is already set.
-
- -or-
-
- <see cref="P:System.Threading.CountdownEvent.CurrentCount" /> is equal to or greater than <see cref="F:System.Int32.MaxValue" /> after count is incremented by <paramref name="signalCount" />.</exception>
+ <exception cref="T:System.InvalidOperationException">The current instance is already set.
+-or-
+<see cref="P:System.Threading.CountdownEvent.CurrentCount" /> is equal to or greater than <see cref="F:System.Int32.MaxValue" /> after count is incremented by <paramref name="signalCount." /></exception>
+ </member>
+ <member name="P:System.Threading.CountdownEvent.CurrentCount">
+ <summary>Gets the number of remaining signals required to set the event.</summary>
+ <returns>The number of remaining signals required to set the event.</returns>
</member>
<member name="M:System.Threading.CountdownEvent.Dispose">
<summary>Releases all resources used by the current instance of the <see cref="T:System.Threading.CountdownEvent" /> class.</summary>
<summary>Releases the unmanaged resources used by the <see cref="T:System.Threading.CountdownEvent" />, and optionally releases the managed resources.</summary>
<param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
</member>
+ <member name="P:System.Threading.CountdownEvent.InitialCount">
+ <summary>Gets the numbers of signals initially required to set the event.</summary>
+ <returns>The number of signals initially required to set the event.</returns>
+ </member>
+ <member name="P:System.Threading.CountdownEvent.IsSet">
+ <summary>Indicates whether the <see cref="T:System.Threading.CountdownEvent" /> object's current count has reached zero.</summary>
+ <returns>
+ <see langword="true" /> if the current count is zero; otherwise, <see langword="false" />.</returns>
+ </member>
<member name="M:System.Threading.CountdownEvent.Reset">
<summary>Resets the <see cref="P:System.Threading.CountdownEvent.CurrentCount" /> to the value of <see cref="P:System.Threading.CountdownEvent.InitialCount" />.</summary>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
</member>
<member name="M:System.Threading.CountdownEvent.Signal">
<summary>Registers a signal with the <see cref="T:System.Threading.CountdownEvent" />, decrementing the value of <see cref="P:System.Threading.CountdownEvent.CurrentCount" />.</summary>
- <exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
- <exception cref="T:System.InvalidOperationException">The current instance is already set.</exception>
<returns>
<see langword="true" /> if the signal caused the count to reach zero and the event was set; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
+ <exception cref="T:System.InvalidOperationException">The current instance is already set.</exception>
</member>
<member name="M:System.Threading.CountdownEvent.Signal(System.Int32)">
<summary>Registers multiple signals with the <see cref="T:System.Threading.CountdownEvent" />, decrementing the value of <see cref="P:System.Threading.CountdownEvent.CurrentCount" /> by the specified amount.</summary>
<param name="signalCount">The number of signals to register.</param>
+ <returns>
+ <see langword="true" /> if the signals caused the count to reach zero and the event was set; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="signalCount" /> is less than 1.</exception>
<exception cref="T:System.InvalidOperationException">The current instance is already set. -or- Or <paramref name="signalCount" /> is greater than <see cref="P:System.Threading.CountdownEvent.CurrentCount" />.</exception>
- <returns>
- <see langword="true" /> if the signals caused the count to reach zero and the event was set; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Threading.CountdownEvent.TryAddCount">
<summary>Attempts to increment <see cref="P:System.Threading.CountdownEvent.CurrentCount" /> by one.</summary>
+ <returns>
+ <see langword="true" /> if the increment succeeded; otherwise, false. If <see cref="P:System.Threading.CountdownEvent.CurrentCount" /> is already at zero, this method will return <see langword="false" />.</returns>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
<exception cref="T:System.InvalidOperationException">
<see cref="P:System.Threading.CountdownEvent.CurrentCount" /> is equal to <see cref="F:System.Int32.MaxValue" />.</exception>
- <returns>
- <see langword="true" /> if the increment succeeded; otherwise, false. If <see cref="P:System.Threading.CountdownEvent.CurrentCount" /> is already at zero, this method will return <see langword="false" />.</returns>
</member>
<member name="M:System.Threading.CountdownEvent.TryAddCount(System.Int32)">
<summary>Attempts to increment <see cref="P:System.Threading.CountdownEvent.CurrentCount" /> by a specified value.</summary>
<param name="signalCount">The value by which to increase <see cref="P:System.Threading.CountdownEvent.CurrentCount" />.</param>
+ <returns>
+ <see langword="true" /> if the increment succeeded; otherwise, false. If <see cref="P:System.Threading.CountdownEvent.CurrentCount" /> is already at zero this will return <see langword="false" />.</returns>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="signalCount" /> is less than or equal to 0.</exception>
<exception cref="T:System.InvalidOperationException">
<see cref="P:System.Threading.CountdownEvent.CurrentCount" /> + <paramref name="signalCount" /> is equal to or greater than <see cref="F:System.Int32.MaxValue" />.</exception>
- <returns>
- <see langword="true" /> if the increment succeeded; otherwise, false. If <see cref="P:System.Threading.CountdownEvent.CurrentCount" /> is already at zero this will return <see langword="false" />.</returns>
</member>
<member name="M:System.Threading.CountdownEvent.Wait">
<summary>Blocks the current thread until the <see cref="T:System.Threading.CountdownEvent" /> is set.</summary>
<member name="M:System.Threading.CountdownEvent.Wait(System.Int32)">
<summary>Blocks the current thread until the <see cref="T:System.Threading.CountdownEvent" /> is set, using a 32-bit signed integer to measure the timeout.</summary>
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" />(-1) to wait indefinitely.</param>
+ <returns>
+ <see langword="true" /> if the <see cref="T:System.Threading.CountdownEvent" /> was set; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.</exception>
- <returns>
- <see langword="true" /> if the <see cref="T:System.Threading.CountdownEvent" /> was set; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Threading.CountdownEvent.Wait(System.Int32,System.Threading.CancellationToken)">
<summary>Blocks the current thread until the <see cref="T:System.Threading.CountdownEvent" /> is set, using a 32-bit signed integer to measure the timeout, while observing a <see cref="T:System.Threading.CancellationToken" />.</summary>
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" />(-1) to wait indefinitely.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to observe.</param>
+ <returns>
+ <see langword="true" /> if the <see cref="T:System.Threading.CountdownEvent" /> was set; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.OperationCanceledException">
<paramref name="cancellationToken" /> has been canceled.</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed. -or- The <see cref="T:System.Threading.CancellationTokenSource" /> that created <paramref name="cancellationToken" /> has already been disposed.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.</exception>
- <returns>
- <see langword="true" /> if the <see cref="T:System.Threading.CountdownEvent" /> was set; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Threading.CountdownEvent.Wait(System.Threading.CancellationToken)">
<summary>Blocks the current thread until the <see cref="T:System.Threading.CountdownEvent" /> is set, while observing a <see cref="T:System.Threading.CancellationToken" />.</summary>
<member name="M:System.Threading.CountdownEvent.Wait(System.TimeSpan)">
<summary>Blocks the current thread until the <see cref="T:System.Threading.CountdownEvent" /> is set, using a <see cref="T:System.TimeSpan" /> to measure the timeout.</summary>
<param name="timeout">A <see cref="T:System.TimeSpan" /> that represents the number of milliseconds to wait, or a <see cref="T:System.TimeSpan" /> that represents -1 milliseconds to wait indefinitely.</param>
+ <returns>
+ <see langword="true" /> if the <see cref="T:System.Threading.CountdownEvent" /> was set; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="timeout" /> is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
- <returns>
- <see langword="true" /> if the <see cref="T:System.Threading.CountdownEvent" /> was set; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Threading.CountdownEvent.Wait(System.TimeSpan,System.Threading.CancellationToken)">
<summary>Blocks the current thread until the <see cref="T:System.Threading.CountdownEvent" /> is set, using a <see cref="T:System.TimeSpan" /> to measure the timeout, while observing a <see cref="T:System.Threading.CancellationToken" />.</summary>
<param name="timeout">A <see cref="T:System.TimeSpan" /> that represents the number of milliseconds to wait, or a <see cref="T:System.TimeSpan" /> that represents -1 milliseconds to wait indefinitely.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to observe.</param>
+ <returns>
+ <see langword="true" /> if the <see cref="T:System.Threading.CountdownEvent" /> was set; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.OperationCanceledException">
<paramref name="cancellationToken" /> has been canceled.</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed. -or- The <see cref="T:System.Threading.CancellationTokenSource" /> that created <paramref name="cancellationToken" /> has already been disposed.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="timeout" /> is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
- <returns>
- <see langword="true" /> if the <see cref="T:System.Threading.CountdownEvent" /> was set; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Threading.CountdownEvent.CurrentCount">
- <summary>Gets the number of remaining signals required to set the event.</summary>
- <returns>The number of remaining signals required to set the event.</returns>
- </member>
- <member name="P:System.Threading.CountdownEvent.InitialCount">
- <summary>Gets the numbers of signals initially required to set the event.</summary>
- <returns>The number of signals initially required to set the event.</returns>
- </member>
- <member name="P:System.Threading.CountdownEvent.IsSet">
- <summary>Indicates whether the <see cref="T:System.Threading.CountdownEvent" /> object's current count has reached zero.</summary>
- <returns>
- <see langword="true" /> if the current count is zero; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.Threading.CountdownEvent.WaitHandle">
<summary>Gets a <see cref="T:System.Threading.WaitHandle" /> that is used to wait for the event to be set.</summary>
- <exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
<returns>A <see cref="T:System.Threading.WaitHandle" /> that is used to wait for the event to be set.</returns>
+ <exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
</member>
<member name="T:System.Threading.EventResetMode">
<summary>Indicates whether an <see cref="T:System.Threading.EventWaitHandle" /> is reset automatically or manually after receiving a signal.</summary>
<param name="initialState">
<see langword="true" /> to set the initial state to signaled; <see langword="false" /> to set it to nonsignaled.</param>
<param name="mode">One of the <see cref="T:System.Threading.EventResetMode" /> values that determines whether the event resets automatically or manually.</param>
- <exception cref="T:System.ArgumentException">The <paramref name="mode" /> enum value was out of legal range.</exception>
</member>
<member name="M:System.Threading.EventWaitHandle.#ctor(System.Boolean,System.Threading.EventResetMode,System.String)">
<summary>Initializes a new instance of the <see cref="T:System.Threading.EventWaitHandle" /> class, specifying whether the wait handle is initially signaled if created as a result of this call, whether it resets automatically or manually, and the name of a system synchronization event.</summary>
<param name="initialState">
<see langword="true" /> to set the initial state to signaled if the named event is created as a result of this call; <see langword="false" /> to set it to nonsignaled.</param>
<param name="mode">One of the <see cref="T:System.Threading.EventResetMode" /> values that determines whether the event resets automatically or manually.</param>
- <param name="name">The name, if the synchronization object is to be shared with other processes; otherwise, <see langword="null" /> or an empty string. The name is case-sensitive.</param>
- <exception cref="T:System.IO.IOException">
- <paramref name="name" /> is invalid. This can be for various reasons, including some restrictions that may be placed by the operating system, such as an unknown prefix or invalid characters. Note that the name and common prefixes "Global" and "Local" are case-sensitive.
-
--or-
-
-There was some other error. The HResult property may provide more information.</exception>
- <exception cref="T:System.IO.DirectoryNotFoundException">Windows only: <paramref name="name" /> specified an unknown namespace. See Object Names for more information.</exception>
- <exception cref="T:System.IO.PathTooLongException">The <paramref name="name" /> is too long. Length restrictions may depend on the operating system or configuration.</exception>
+ <param name="name">The name of a system-wide synchronization event.</param>
+ <exception cref="T:System.IO.IOException">A Win32 error occurred.</exception>
<exception cref="T:System.UnauthorizedAccessException">The named event exists and has access control security, but the user does not have <see cref="F:System.Security.AccessControl.EventWaitHandleRights.FullControl" />.</exception>
- <exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">A synchronization object with the provided <paramref name="name" /> cannot be created. A synchronization object of a different type might have the same name.</exception>
+ <exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">The named event cannot be created, perhaps because a wait handle of a different type has the same name.</exception>
<exception cref="T:System.ArgumentException">
- The <paramref name="mode" /> enum value was out of legal range.
-
--or-
-
-.NET Framework only: <paramref name="name" /> is longer than MAX_PATH (260 characters).</exception>
+ <paramref name="name" /> is longer than 260 characters.</exception>
</member>
<member name="M:System.Threading.EventWaitHandle.#ctor(System.Boolean,System.Threading.EventResetMode,System.String,System.Boolean@)">
<summary>Initializes a new instance of the <see cref="T:System.Threading.EventWaitHandle" /> class, specifying whether the wait handle is initially signaled if created as a result of this call, whether it resets automatically or manually, the name of a system synchronization event, and a Boolean variable whose value after the call indicates whether the named system event was created.</summary>
<param name="initialState">
<see langword="true" /> to set the initial state to signaled if the named event is created as a result of this call; <see langword="false" /> to set it to nonsignaled.</param>
<param name="mode">One of the <see cref="T:System.Threading.EventResetMode" /> values that determines whether the event resets automatically or manually.</param>
- <param name="name">The name, if the synchronization object is to be shared with other processes; otherwise, <see langword="null" /> or an empty string. The name is case-sensitive.</param>
+ <param name="name">The name of a system-wide synchronization event.</param>
<param name="createdNew">When this method returns, contains <see langword="true" /> if a local event was created (that is, if <paramref name="name" /> is <see langword="null" /> or an empty string) or if the specified named system event was created; <see langword="false" /> if the specified named system event already existed. This parameter is passed uninitialized.</param>
- <exception cref="T:System.IO.IOException">
- <paramref name="name" /> is invalid. This can be for various reasons, including some restrictions that may be placed by the operating system, such as an unknown prefix or invalid characters. Note that the name and common prefixes "Global" and "Local" are case-sensitive.
-
--or-
-
-There was some other error. The HResult property may provide more information.</exception>
- <exception cref="T:System.IO.DirectoryNotFoundException">Windows only: <paramref name="name" /> specified an unknown namespace. See Object Names for more information.</exception>
- <exception cref="T:System.IO.PathTooLongException">The <paramref name="name" /> is too long. Length restrictions may depend on the operating system or configuration.</exception>
+ <exception cref="T:System.IO.IOException">A Win32 error occurred.</exception>
<exception cref="T:System.UnauthorizedAccessException">The named event exists and has access control security, but the user does not have <see cref="F:System.Security.AccessControl.EventWaitHandleRights.FullControl" />.</exception>
- <exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">A synchronization object with the provided <paramref name="name" /> cannot be created. A synchronization object of a different type might have the same name.</exception>
+ <exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">The named event cannot be created, perhaps because a wait handle of a different type has the same name.</exception>
<exception cref="T:System.ArgumentException">
- The <paramref name="mode" /> enum value was out of legal range.
-
--or-
-
-.NET Framework only: <paramref name="name" /> is longer than MAX_PATH (260 characters).</exception>
+ <paramref name="name" /> is longer than 260 characters.</exception>
</member>
<member name="M:System.Threading.EventWaitHandle.OpenExisting(System.String)">
<summary>Opens the specified named synchronization event, if it already exists.</summary>
- <param name="name">The name of the synchronization object to be opened and shared with other processes. The name is case-sensitive.</param>
- <exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">A synchronization object with the provided <paramref name="name" /> cannot be opened. It may not exist, or a synchronization object of a different type might have the same name. In some cases, this exception may be thrown for invalid names.</exception>
+ <param name="name">The name of the system synchronization event to open.</param>
+ <returns>An object that represents the named system event.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="name" /> is an empty string.
-
-or-
-
-.NET Framework only: <paramref name="name" /> is longer than MAX_PATH (260 characters).</exception>
+<paramref name="name" /> is longer than 260 characters.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> is <see langword="null" />.</exception>
- <exception cref="T:System.IO.IOException">
- <paramref name="name" /> is invalid. This can be for various reasons, including some restrictions that may be placed by the operating system, such as an unknown prefix or invalid characters. Note that the name and common prefixes "Global" and "Local" are case-sensitive.
-
--or-
-
-There was some other error. The HResult property may provide more information.</exception>
- <exception cref="T:System.IO.DirectoryNotFoundException">Windows only: <paramref name="name" /> specified an unknown namespace. See Object Names for more information.</exception>
- <exception cref="T:System.IO.PathTooLongException">The <paramref name="name" /> is too long. Length restrictions may depend on the operating system or configuration.</exception>
+ <exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">The named system event does not exist.</exception>
+ <exception cref="T:System.IO.IOException">A Win32 error occurred.</exception>
<exception cref="T:System.UnauthorizedAccessException">The named event exists, but the user does not have the security access required to use it.</exception>
- <returns>An object that represents the named system event.</returns>
</member>
<member name="M:System.Threading.EventWaitHandle.Reset">
<summary>Sets the state of the event to nonsignaled, causing threads to block.</summary>
- <exception cref="T:System.ObjectDisposedException">The <see cref="M:System.Threading.WaitHandle.Close" /> method was previously called on this <see cref="T:System.Threading.EventWaitHandle" />.</exception>
<returns>
<see langword="true" /> if the operation succeeds; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.ObjectDisposedException">The <see cref="M:System.Threading.WaitHandle.Close" /> method was previously called on this <see cref="T:System.Threading.EventWaitHandle" />.</exception>
</member>
<member name="M:System.Threading.EventWaitHandle.Set">
<summary>Sets the state of the event to signaled, allowing one or more waiting threads to proceed.</summary>
- <exception cref="T:System.ObjectDisposedException">The <see cref="M:System.Threading.WaitHandle.Close" /> method was previously called on this <see cref="T:System.Threading.EventWaitHandle" />.</exception>
<returns>
<see langword="true" /> if the operation succeeds; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.ObjectDisposedException">The <see cref="M:System.Threading.WaitHandle.Close" /> method was previously called on this <see cref="T:System.Threading.EventWaitHandle" />.</exception>
</member>
<member name="M:System.Threading.EventWaitHandle.TryOpenExisting(System.String,System.Threading.EventWaitHandle@)">
<summary>Opens the specified named synchronization event, if it already exists, and returns a value that indicates whether the operation succeeded.</summary>
- <param name="name">The name of the synchronization object to be opened and shared with other processes. The name is case-sensitive.</param>
+ <param name="name">The name of the system synchronization event to open.</param>
<param name="result">When this method returns, contains a <see cref="T:System.Threading.EventWaitHandle" /> object that represents the named synchronization event if the call succeeded, or <see langword="null" /> if the call failed. This parameter is treated as uninitialized.</param>
+ <returns>
+ <see langword="true" /> if the named synchronization event was opened successfully; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="name" /> is an empty string.
-
-or-
-
-.NET Framework only: <paramref name="name" /> is longer than MAX_PATH (260 characters).</exception>
+<paramref name="name" /> is longer than 260 characters.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> is <see langword="null" />.</exception>
- <exception cref="T:System.IO.IOException">
- <paramref name="name" /> is invalid. This can be for various reasons, including some restrictions that may be placed by the operating system, such as an unknown prefix or invalid characters. Note that the name and common prefixes "Global" and "Local" are case-sensitive. For some invalid names, the method may return <see langword="false" /> instead.
-
--or-
-
-There was some other error. The HResult property may provide more information.</exception>
- <exception cref="T:System.IO.PathTooLongException">The <paramref name="name" /> is too long. Length restrictions may depend on the operating system or configuration.</exception>
+ <exception cref="T:System.IO.IOException">A Win32 error occurred.</exception>
<exception cref="T:System.UnauthorizedAccessException">The named event exists, but the user does not have the desired security access.</exception>
- <returns>
- <see langword="true" /> if the named synchronization event was opened successfully; otherwise, <see langword="false" />. In some cases, <see langword="false" /> may be returned for invalid names.</returns>
</member>
<member name="T:System.Threading.ExecutionContext">
<summary>Manages the execution context for the current thread. This class cannot be inherited.</summary>
</member>
<member name="M:System.Threading.ExecutionContext.CreateCopy">
<summary>Creates a copy of the current execution context.</summary>
- <exception cref="T:System.InvalidOperationException">This context cannot be copied because it is used. Only newly captured contexts can be copied.</exception>
<returns>An <see cref="T:System.Threading.ExecutionContext" /> object representing the current execution context.</returns>
+ <exception cref="T:System.InvalidOperationException">This context cannot be copied because it is used. Only newly captured contexts can be copied.</exception>
</member>
<member name="M:System.Threading.ExecutionContext.Dispose">
<summary>Releases all resources used by the current instance of the <see cref="T:System.Threading.ExecutionContext" /> class.</summary>
<returns>
<see langword="true" /> if the flow is suppressed; otherwise, <see langword="false" />.</returns>
</member>
- <member name="M:System.Threading.ExecutionContext.Restore(System.Threading.ExecutionContext)">
- <summary>Restores a captured execution context on to the current thread.</summary>
- <param name="executionContext">The ExecutionContext to set.</param>
- <exception cref="T:System.InvalidOperationException">
- <paramref name="executionContext" /> is <see langword="null" />.</exception>
- </member>
<member name="M:System.Threading.ExecutionContext.RestoreFlow">
<summary>Restores the flow of the execution context across asynchronous threads.</summary>
<exception cref="T:System.InvalidOperationException">The context flow cannot be restored because it is not being suppressed.</exception>
<param name="callback">A <see cref="T:System.Threading.ContextCallback" /> delegate that represents the method to be run in the provided execution context.</param>
<param name="state">The object to pass to the callback method.</param>
<exception cref="T:System.InvalidOperationException">
- <paramref name="executionContext" /> is <see langword="null" />.
-
- -or-
-
- <paramref name="executionContext" /> was not acquired through a capture operation.
-
- -or-
-
- <paramref name="executionContext" /> has already been used as the argument to a <see cref="M:System.Threading.ExecutionContext.Run(System.Threading.ExecutionContext,System.Threading.ContextCallback,System.Object)" /> call.</exception>
+ <paramref name="executionContext" /> is <see langword="null" />.
+-or-
+<paramref name="executionContext" /> was not acquired through a capture operation.
+-or-
+<paramref name="executionContext" /> has already been used as the argument to a <see cref="M:System.Threading.ExecutionContext.Run(System.Threading.ExecutionContext,System.Threading.ContextCallback,System.Object)" /> call.</exception>
</member>
<member name="M:System.Threading.ExecutionContext.SuppressFlow">
<summary>Suppresses the flow of the execution context across asynchronous threads.</summary>
- <exception cref="T:System.InvalidOperationException">The context flow is already suppressed.</exception>
<returns>An <see cref="T:System.Threading.AsyncFlowControl" /> structure for restoring the flow.</returns>
+ <exception cref="T:System.InvalidOperationException">The context flow is already suppressed.</exception>
</member>
<member name="T:System.Threading.HostExecutionContext">
<summary>Encapsulates and propagates the host execution context across threads.</summary>
<summary>Restores the host execution context to its prior state.</summary>
<param name="previousState">The previous context state to revert to.</param>
<exception cref="T:System.InvalidOperationException">
- <paramref name="previousState" /> is <see langword="null" />.
-
- -or-
-
- <paramref name="previousState" /> was not created on the current thread.
-
- -or-
-
- <paramref name="previousState" /> is not the last state for the <see cref="T:System.Threading.HostExecutionContext" />.</exception>
+ <paramref name="previousState" /> is <see langword="null" />.
+-or-
+<paramref name="previousState" /> was not created on the current thread.
+-or-
+<paramref name="previousState" /> is not the last state for the <see cref="T:System.Threading.HostExecutionContext" />.</exception>
</member>
<member name="M:System.Threading.HostExecutionContextManager.SetHostExecutionContext(System.Threading.HostExecutionContext)">
<summary>Sets the current host execution context to the specified host execution context.</summary>
<param name="hostExecutionContext">The <see cref="T:System.Threading.HostExecutionContext" /> to be set.</param>
- <exception cref="T:System.InvalidOperationException">
- <paramref name="hostExecutionContext" /> was not acquired through a capture operation.
-
- -or-
-
- <paramref name="hostExecutionContext" /> has been the argument to a previous <see cref="M:System.Threading.HostExecutionContextManager.SetHostExecutionContext(System.Threading.HostExecutionContext)" /> method call.</exception>
<returns>An object for restoring the <see cref="T:System.Threading.HostExecutionContext" /> to its previous state.</returns>
+ <exception cref="T:System.InvalidOperationException">
+ <paramref name="hostExecutionContext" /> was not acquired through a capture operation.
+-or-
+<paramref name="hostExecutionContext" /> has been the argument to a previous <see cref="M:System.Threading.HostExecutionContextManager.SetHostExecutionContext(System.Threading.HostExecutionContext)" /> method call.</exception>
</member>
<member name="T:System.Threading.Interlocked">
<summary>Provides atomic operations for variables that are shared by multiple threads.</summary>
<summary>Adds two 32-bit integers and replaces the first integer with the sum, as an atomic operation.</summary>
<param name="location1">A variable containing the first value to be added. The sum of the two values is stored in <paramref name="location1" />.</param>
<param name="value">The value to be added to the integer at <paramref name="location1" />.</param>
+ <returns>The new value stored at <paramref name="location1" />.</returns>
<exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a null pointer.</exception>
- <returns>The new value that was stored at <paramref name="location1" /> by this operation.</returns>
</member>
<member name="M:System.Threading.Interlocked.Add(System.Int64@,System.Int64)">
<summary>Adds two 64-bit integers and replaces the first integer with the sum, as an atomic operation.</summary>
<param name="location1">A variable containing the first value to be added. The sum of the two values is stored in <paramref name="location1" />.</param>
<param name="value">The value to be added to the integer at <paramref name="location1" />.</param>
+ <returns>The new value stored at <paramref name="location1" />.</returns>
<exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a null pointer.</exception>
- <returns>The new value that was stored at <paramref name="location1" /> by this operation.</returns>
- </member>
- <member name="M:System.Threading.Interlocked.Add(System.UInt32@,System.UInt32)">
- <summary>Adds two 32-bit unsigned integers and replaces the first integer with the sum, as an atomic operation.</summary>
- <param name="location1">A variable containing the first value to be added. The sum of the two values is stored in <paramref name="location1" />.</param>
- <param name="value">The value to be added to the integer at <paramref name="location1" />.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
- <returns>The new value that was stored at <paramref name="location1" /> by this operation.</returns>
- </member>
- <member name="M:System.Threading.Interlocked.Add(System.UInt64@,System.UInt64)">
- <summary>Adds two 64-bit unsigned integers and replaces the first integer with the sum, as an atomic operation.</summary>
- <param name="location1">A variable containing the first value to be added. The sum of the two values is stored in <paramref name="location1" />.</param>
- <param name="value">The value to be added to the integer at <paramref name="location1" />.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
- <returns>The new value that was stored at <paramref name="location1" /> by this operation.</returns>
- </member>
- <member name="M:System.Threading.Interlocked.And(System.Int32@,System.Int32)">
- <summary>Bitwise "ands" two 32-bit signed integers and replaces the first integer with the result, as an atomic operation.</summary>
- <param name="location1">A variable containing the first value to be combined. The result is stored in <paramref name="location1" />.</param>
- <param name="value">The value to be combined with the integer at <paramref name="location1" />.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
- <returns>The original value in <paramref name="location1" />.</returns>
- </member>
- <member name="M:System.Threading.Interlocked.And(System.Int64@,System.Int64)">
- <summary>Bitwise "ands" two 64-bit signed integers and replaces the first integer with the result, as an atomic operation.</summary>
- <param name="location1">A variable containing the first value to be combined. The result is stored in <paramref name="location1" />.</param>
- <param name="value">The value to be combined with the integer at <paramref name="location1" />.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
- <returns>The original value in <paramref name="location1" />.</returns>
- </member>
- <member name="M:System.Threading.Interlocked.And(System.UInt32@,System.UInt32)">
- <summary>Bitwise "ands" two 32-bit unsigned integers and replaces the first integer with the result, as an atomic operation.</summary>
- <param name="location1">A variable containing the first value to be combined. The result is stored in <paramref name="location1" />.</param>
- <param name="value">The value to be combined with the integer at <paramref name="location1" />.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
- <returns>The original value in <paramref name="location1" />.</returns>
- </member>
- <member name="M:System.Threading.Interlocked.And(System.UInt64@,System.UInt64)">
- <summary>Bitwise "ands" two 64-bit unsigned integers and replaces the first integer with the result, as an atomic operation.</summary>
- <param name="location1">A variable containing the first value to be combined. The result is stored in <paramref name="location1" />.</param>
- <param name="value">The value to be combined with the integer at <paramref name="location1" />.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
- <returns>The original value in <paramref name="location1" />.</returns>
</member>
<member name="M:System.Threading.Interlocked.CompareExchange(System.Double@,System.Double,System.Double)">
<summary>Compares two double-precision floating point numbers for equality and, if they are equal, replaces the first value.</summary>
<param name="location1">The destination, whose value is compared with <paramref name="comparand" /> and possibly replaced.</param>
<param name="value">The value that replaces the destination value if the comparison results in equality.</param>
<param name="comparand">The value that is compared to the value at <paramref name="location1" />.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a null pointer.</exception>
<returns>The original value in <paramref name="location1" />.</returns>
+ <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a null pointer.</exception>
</member>
<member name="M:System.Threading.Interlocked.CompareExchange(System.Int32@,System.Int32,System.Int32)">
<summary>Compares two 32-bit signed integers for equality and, if they are equal, replaces the first value.</summary>
<param name="location1">The destination, whose value is compared with <paramref name="comparand" /> and possibly replaced.</param>
<param name="value">The value that replaces the destination value if the comparison results in equality.</param>
<param name="comparand">The value that is compared to the value at <paramref name="location1" />.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a null pointer.</exception>
<returns>The original value in <paramref name="location1" />.</returns>
+ <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a null pointer.</exception>
</member>
<member name="M:System.Threading.Interlocked.CompareExchange(System.Int64@,System.Int64,System.Int64)">
<summary>Compares two 64-bit signed integers for equality and, if they are equal, replaces the first value.</summary>
<param name="location1">The destination, whose value is compared with <paramref name="comparand" /> and possibly replaced.</param>
<param name="value">The value that replaces the destination value if the comparison results in equality.</param>
<param name="comparand">The value that is compared to the value at <paramref name="location1" />.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a null pointer.</exception>
<returns>The original value in <paramref name="location1" />.</returns>
+ <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a null pointer.</exception>
</member>
<member name="M:System.Threading.Interlocked.CompareExchange(System.IntPtr@,System.IntPtr,System.IntPtr)">
<summary>Compares two platform-specific handles or pointers for equality and, if they are equal, replaces the first one.</summary>
<param name="location1">The destination <see cref="T:System.IntPtr" />, whose value is compared with the value of <paramref name="comparand" /> and possibly replaced by <paramref name="value" />.</param>
<param name="value">The <see cref="T:System.IntPtr" /> that replaces the destination value if the comparison results in equality.</param>
<param name="comparand">The <see cref="T:System.IntPtr" /> that is compared to the value at <paramref name="location1" />.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a null pointer.</exception>
<returns>The original value in <paramref name="location1" />.</returns>
+ <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a null pointer.</exception>
</member>
<member name="M:System.Threading.Interlocked.CompareExchange(System.Object@,System.Object,System.Object)">
<summary>Compares two objects for reference equality and, if they are equal, replaces the first object.</summary>
<param name="location1">The destination object that is compared by reference with <paramref name="comparand" /> and possibly replaced.</param>
<param name="value">The object that replaces the destination object if the reference comparison results in equality.</param>
<param name="comparand">The object that is compared by reference to the object at <paramref name="location1" />.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
<returns>The original value in <paramref name="location1" />.</returns>
+ <exception cref="T:System.ArgumentNullException">The address of <paramref name="location1" /> is a null pointer.</exception>
</member>
<member name="M:System.Threading.Interlocked.CompareExchange(System.Single@,System.Single,System.Single)">
<summary>Compares two single-precision floating point numbers for equality and, if they are equal, replaces the first value.</summary>
<param name="location1">The destination, whose value is compared with <paramref name="comparand" /> and possibly replaced.</param>
<param name="value">The value that replaces the destination value if the comparison results in equality.</param>
<param name="comparand">The value that is compared to the value at <paramref name="location1" />.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a null pointer.</exception>
- <returns>The original value in <paramref name="location1" />.</returns>
- </member>
- <member name="M:System.Threading.Interlocked.CompareExchange(System.UInt32@,System.UInt32,System.UInt32)">
- <summary>Compares two 32-bit unsigned integers for equality and, if they are equal, replaces the first value.</summary>
- <param name="location1">The destination, whose value is compared with <paramref name="comparand" /> and possibly replaced.</param>
- <param name="value">The value that replaces the destination value if the comparison results in equality.</param>
- <param name="comparand">The value that is compared to the value at <paramref name="location1" />.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
- <returns>The original value in <paramref name="location1" />.</returns>
- </member>
- <member name="M:System.Threading.Interlocked.CompareExchange(System.UInt64@,System.UInt64,System.UInt64)">
- <summary>Compares two 64-bit unsigned integers for equality and, if they are equal, replaces the first value.</summary>
- <param name="location1">The destination, whose value is compared with <paramref name="comparand" /> and possibly replaced.</param>
- <param name="value">The value that replaces the destination value if the comparison results in equality.</param>
- <param name="comparand">The value that is compared to the value at <paramref name="location1" />.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
<returns>The original value in <paramref name="location1" />.</returns>
+ <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a null pointer.</exception>
</member>
<member name="M:System.Threading.Interlocked.CompareExchange``1(``0@,``0,``0)">
<summary>Compares two instances of the specified reference type <paramref name="T" /> for reference equality and, if they are equal, replaces the first one.</summary>
<param name="value">The value that replaces the destination value if the comparison by reference results in equality.</param>
<param name="comparand">The value that is compared by reference to the value at <paramref name="location1" />.</param>
<typeparam name="T">The type to be used for <paramref name="location1" />, <paramref name="value" />, and <paramref name="comparand" />. This type must be a reference type.</typeparam>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a null pointer.</exception>
<returns>The original value in <paramref name="location1" />.</returns>
+ <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a null pointer.</exception>
</member>
<member name="M:System.Threading.Interlocked.Decrement(System.Int32@)">
<summary>Decrements a specified variable and stores the result, as an atomic operation.</summary>
<param name="location">The variable whose value is to be decremented.</param>
- <exception cref="T:System.ArgumentNullException">The address of <paramref name="location" /> is a <see langword="null" /> pointer.</exception>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location" /> is a <see langword="null" /> pointer.</exception>
<returns>The decremented value.</returns>
+ <exception cref="T:System.ArgumentNullException">The address of <paramref name="location" /> is a null pointer.</exception>
</member>
<member name="M:System.Threading.Interlocked.Decrement(System.Int64@)">
<summary>Decrements the specified variable and stores the result, as an atomic operation.</summary>
<param name="location">The variable whose value is to be decremented.</param>
- <exception cref="T:System.ArgumentNullException">The address of <paramref name="location" /> is a <see langword="null" /> pointer.</exception>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location" /> is a <see langword="null" /> pointer.</exception>
- <returns>The decremented value.</returns>
- </member>
- <member name="M:System.Threading.Interlocked.Decrement(System.UInt32@)">
- <summary>Decrements a specified variable and stores the result, as an atomic operation.</summary>
- <param name="location">The variable whose value is to be decremented.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location" /> is a <see langword="null" /> pointer.</exception>
- <returns>The decremented value.</returns>
- </member>
- <member name="M:System.Threading.Interlocked.Decrement(System.UInt64@)">
- <summary>Decrements a specified variable and stores the result, as an atomic operation.</summary>
- <param name="location">The variable whose value is to be decremented.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location" /> is a <see langword="null" /> pointer.</exception>
<returns>The decremented value.</returns>
+ <exception cref="T:System.ArgumentNullException">The address of <paramref name="location" /> is a null pointer.</exception>
</member>
<member name="M:System.Threading.Interlocked.Exchange(System.Double@,System.Double)">
<summary>Sets a double-precision floating point number to a specified value and returns the original value, as an atomic operation.</summary>
<param name="location1">The variable to set to the specified value.</param>
<param name="value">The value to which the <paramref name="location1" /> parameter is set.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
<returns>The original value of <paramref name="location1" />.</returns>
+ <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a null pointer.</exception>
</member>
<member name="M:System.Threading.Interlocked.Exchange(System.Int32@,System.Int32)">
<summary>Sets a 32-bit signed integer to a specified value and returns the original value, as an atomic operation.</summary>
<param name="location1">The variable to set to the specified value.</param>
<param name="value">The value to which the <paramref name="location1" /> parameter is set.</param>
- <exception cref="T:System.ArgumentNullException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
<returns>The original value of <paramref name="location1" />.</returns>
+ <exception cref="T:System.ArgumentNullException">The address of <paramref name="location1" /> is a null pointer.</exception>
</member>
<member name="M:System.Threading.Interlocked.Exchange(System.Int64@,System.Int64)">
<summary>Sets a 64-bit signed integer to a specified value and returns the original value, as an atomic operation.</summary>
<param name="location1">The variable to set to the specified value.</param>
<param name="value">The value to which the <paramref name="location1" /> parameter is set.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
<returns>The original value of <paramref name="location1" />.</returns>
+ <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a null pointer.</exception>
</member>
<member name="M:System.Threading.Interlocked.Exchange(System.IntPtr@,System.IntPtr)">
<summary>Sets a platform-specific handle or pointer to a specified value and returns the original value, as an atomic operation.</summary>
<param name="location1">The variable to set to the specified value.</param>
<param name="value">The value to which the <paramref name="location1" /> parameter is set.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
<returns>The original value of <paramref name="location1" />.</returns>
+ <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a null pointer.</exception>
</member>
<member name="M:System.Threading.Interlocked.Exchange(System.Object@,System.Object)">
<summary>Sets an object to a specified value and returns a reference to the original object, as an atomic operation.</summary>
<param name="location1">The variable to set to the specified value.</param>
<param name="value">The value to which the <paramref name="location1" /> parameter is set.</param>
- <exception cref="T:System.ArgumentNullException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
<returns>The original value of <paramref name="location1" />.</returns>
+ <exception cref="T:System.ArgumentNullException">The address of <paramref name="location1" /> is a null pointer.</exception>
</member>
<member name="M:System.Threading.Interlocked.Exchange(System.Single@,System.Single)">
<summary>Sets a single-precision floating point number to a specified value and returns the original value, as an atomic operation.</summary>
<param name="location1">The variable to set to the specified value.</param>
<param name="value">The value to which the <paramref name="location1" /> parameter is set.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
- <returns>The original value of <paramref name="location1" />.</returns>
- </member>
- <member name="M:System.Threading.Interlocked.Exchange(System.UInt32@,System.UInt32)">
- <summary>Sets a 32-bit unsigned integer to a specified value and returns the original value, as an atomic operation.</summary>
- <param name="location1">The variable to set to the specified value.</param>
- <param name="value">The value to which the <paramref name="location1" /> parameter is set.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
- <returns>The original value of <paramref name="location1" />.</returns>
- </member>
- <member name="M:System.Threading.Interlocked.Exchange(System.UInt64@,System.UInt64)">
- <summary>Sets a 64-bit unsigned integer to a specified value and returns the original value, as an atomic operation.</summary>
- <param name="location1">The variable to set to the specified value.</param>
- <param name="value">The value to which the <paramref name="location1" /> parameter is set.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
<returns>The original value of <paramref name="location1" />.</returns>
+ <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a null pointer.</exception>
</member>
<member name="M:System.Threading.Interlocked.Exchange``1(``0@,``0)">
<summary>Sets a variable of the specified type <paramref name="T" /> to a specified value and returns the original value, as an atomic operation.</summary>
<param name="location1">The variable to set to the specified value. This is a reference parameter (<see langword="ref" /> in C#, <see langword="ByRef" /> in Visual Basic).</param>
<param name="value">The value to which the <paramref name="location1" /> parameter is set.</param>
<typeparam name="T">The type to be used for <paramref name="location1" /> and <paramref name="value" />. This type must be a reference type.</typeparam>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
<returns>The original value of <paramref name="location1" />.</returns>
+ <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a null pointer.</exception>
</member>
<member name="M:System.Threading.Interlocked.Increment(System.Int32@)">
<summary>Increments a specified variable and stores the result, as an atomic operation.</summary>
<param name="location">The variable whose value is to be incremented.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location" /> is a <see langword="null" /> pointer.</exception>
<returns>The incremented value.</returns>
+ <exception cref="T:System.NullReferenceException">The address of <paramref name="location" /> is a null pointer.</exception>
</member>
<member name="M:System.Threading.Interlocked.Increment(System.Int64@)">
<summary>Increments a specified variable and stores the result, as an atomic operation.</summary>
<param name="location">The variable whose value is to be incremented.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location" /> is a <see langword="null" /> pointer.</exception>
- <returns>The incremented value.</returns>
- </member>
- <member name="M:System.Threading.Interlocked.Increment(System.UInt32@)">
- <summary>Increments a specified variable and stores the result, as an atomic operation.</summary>
- <param name="location">The variable whose value is to be incremented.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location" /> is a <see langword="null" /> pointer.</exception>
- <returns>The incremented value.</returns>
- </member>
- <member name="M:System.Threading.Interlocked.Increment(System.UInt64@)">
- <summary>Increments a specified variable and stores the result, as an atomic operation.</summary>
- <param name="location">The variable whose value is to be incremented.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location" /> is a <see langword="null" /> pointer.</exception>
<returns>The incremented value.</returns>
+ <exception cref="T:System.NullReferenceException">The address of <paramref name="location" /> is a null pointer.</exception>
</member>
<member name="M:System.Threading.Interlocked.MemoryBarrier">
<summary>Synchronizes memory access as follows: The processor that executes the current thread cannot reorder instructions in such a way that memory accesses before the call to <see cref="M:System.Threading.Interlocked.MemoryBarrier" /> execute after memory accesses that follow the call to <see cref="M:System.Threading.Interlocked.MemoryBarrier" />.</summary>
<member name="M:System.Threading.Interlocked.MemoryBarrierProcessWide">
<summary>Provides a process-wide memory barrier that ensures that reads and writes from any CPU cannot move across the barrier.</summary>
</member>
- <member name="M:System.Threading.Interlocked.Or(System.Int32@,System.Int32)">
- <summary>Bitwise "ors" two 32-bit signed integers and replaces the first integer with the result, as an atomic operation.</summary>
- <param name="location1">A variable containing the first value to be combined. The result is stored in <paramref name="location1" />.</param>
- <param name="value">The value to be combined with the integer at <paramref name="location1" />.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
- <returns>The original value in <paramref name="location1" />.</returns>
- </member>
- <member name="M:System.Threading.Interlocked.Or(System.Int64@,System.Int64)">
- <summary>Bitwise "ors" two 64-bit signed integers and replaces the first integer with the result, as an atomic operation.</summary>
- <param name="location1">A variable containing the first value to be combined. The result is stored in <paramref name="location1" />.</param>
- <param name="value">The value to be combined with the integer at <paramref name="location1" />.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
- <returns>The original value in <paramref name="location1" />.</returns>
- </member>
- <member name="M:System.Threading.Interlocked.Or(System.UInt32@,System.UInt32)">
- <summary>Bitwise "ors" two 32-bit unsigned integers and replaces the first integer with the result, as an atomic operation.</summary>
- <param name="location1">A variable containing the first value to be combined. The result is stored in <paramref name="location1" />.</param>
- <param name="value">The value to be combined with the integer at <paramref name="location1" />.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
- <returns>The original value in <paramref name="location1" />.</returns>
- </member>
- <member name="M:System.Threading.Interlocked.Or(System.UInt64@,System.UInt64)">
- <summary>Bitwise "ors" two 64-bit unsigned integers and replaces the first integer with the result, as an atomic operation.</summary>
- <param name="location1">A variable containing the first value to be combined. The result is stored in <paramref name="location1" />.</param>
- <param name="value">The value to be combined with the integer at <paramref name="location1" />.</param>
- <exception cref="T:System.NullReferenceException">The address of <paramref name="location1" /> is a <see langword="null" /> pointer.</exception>
- <returns>The original value in <paramref name="location1" />.</returns>
- </member>
<member name="M:System.Threading.Interlocked.Read(System.Int64@)">
<summary>Returns a 64-bit value, loaded as an atomic operation.</summary>
<param name="location">The 64-bit value to be loaded.</param>
<returns>The loaded value.</returns>
</member>
- <member name="M:System.Threading.Interlocked.Read(System.UInt64@)">
- <summary>Returns a 64-bit unsigned value, loaded as an atomic operation.</summary>
- <param name="location">The 64-bit value to be loaded.</param>
- <returns>The loaded value.</returns>
- </member>
<member name="T:System.Threading.LazyInitializer">
<summary>Provides lazy initialization routines.</summary>
</member>
<member name="M:System.Threading.LazyInitializer.EnsureInitialized``1(``0@)">
<summary>Initializes a target reference type with the type's parameterless constructor if it hasn't already been initialized.</summary>
- <param name="target">A reference to initialize if it has not already been initialized. If it is <see langword="null" />, it is considered not initialized; otherwise, it's considered initialized.</param>
+ <param name="target">A reference to initialize if it has not already been initialized.</param>
<typeparam name="T">The type of the reference to be initialized.</typeparam>
+ <returns>The initialized object.</returns>
<exception cref="T:System.MemberAccessException">Permissions to access the constructor of type <paramref name="T" /> were missing.</exception>
<exception cref="T:System.MissingMemberException">Type <paramref name="T" /> does not have a parameterless constructor.</exception>
- <returns>The initialized object.</returns>
</member>
<member name="M:System.Threading.LazyInitializer.EnsureInitialized``1(``0@,System.Boolean@,System.Object@)">
<summary>Initializes a target reference or value type with its parameterless constructor if it hasn't already been initialized.</summary>
<param name="initialized">A reference to a Boolean value that determines whether the target has already been initialized.</param>
<param name="syncLock">A reference to an object used as the mutually exclusive lock for initializing <paramref name="target" />. If <paramref name="syncLock" /> is <see langword="null" />, a new object will be instantiated.</param>
<typeparam name="T">The type of the reference to be initialized.</typeparam>
+ <returns>The initialized object.</returns>
<exception cref="T:System.MemberAccessException">Permissions to access the constructor of type <paramref name="T" /> were missing.</exception>
<exception cref="T:System.MissingMemberException">Type <paramref name="T" /> does not have a parameterless constructor.</exception>
- <returns>The initialized object.</returns>
</member>
<member name="M:System.Threading.LazyInitializer.EnsureInitialized``1(``0@,System.Boolean@,System.Object@,System.Func{``0})">
<summary>Initializes a target reference or value type by using a specified function if it hasn't already been initialized.</summary>
<param name="syncLock">A reference to an object used as the mutually exclusive lock for initializing <paramref name="target" />. If <paramref name="syncLock" /> is <see langword="null" />, a new object will be instantiated.</param>
<param name="valueFactory">The function that is called to initialize the reference or value.</param>
<typeparam name="T">The type of the reference to be initialized.</typeparam>
+ <returns>The initialized object.</returns>
<exception cref="T:System.MemberAccessException">Permissions to access the constructor of type <paramref name="T" /> were missing.</exception>
<exception cref="T:System.MissingMemberException">Type <paramref name="T" /> does not have a parameterless constructor.</exception>
- <returns>The initialized object.</returns>
</member>
<member name="M:System.Threading.LazyInitializer.EnsureInitialized``1(``0@,System.Func{``0})">
<summary>Initializes a target reference type by using a specified function if it hasn't already been initialized.</summary>
<param name="target">The reference to initialize if it hasn't already been initialized.</param>
<param name="valueFactory">The function that is called to initialize the reference.</param>
<typeparam name="T">The type of the reference to be initialized.</typeparam>
+ <returns>The initialized object.</returns>
<exception cref="T:System.MissingMemberException">Type <paramref name="T" /> does not have a parameterless constructor.</exception>
<exception cref="T:System.InvalidOperationException">
<paramref name="valueFactory" /> returned null (Nothing in Visual Basic).</exception>
- <returns>The initialized object.</returns>
</member>
<member name="M:System.Threading.LazyInitializer.EnsureInitialized``1(``0@,System.Object@,System.Func{``0})">
<summary>Initializes a target reference type with a specified function if it has not already been initialized.</summary>
- <param name="target">A reference to initialize if it has not already been initialized. If it is <see langword="null" />, it is considered not initialized; otherwise, it's considered initialized.</param>
+ <param name="target">A reference to initialize if it has not already been initialized.</param>
<param name="syncLock">A reference to an object used as the mutually exclusive lock for initializing
-
<paramref name="target" />. If <paramref name="syncLock" /> is <see langword="null" />, a new object will be instantiated.</param>
+<paramref name="target" />. If <paramref name="syncLock" /> is <see langword="null" />, a new object will be instantiated.</param>
<param name="valueFactory">The method to invoke to initialize <paramref name="target" />.</param>
<typeparam name="T">The type of the reference to be initialized.</typeparam>
<returns>The initialized object.</returns>
<summary>Releases the unmanaged resources used by the <see cref="T:System.Threading.ManualResetEventSlim" />, and optionally releases the managed resources.</summary>
<param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
</member>
+ <member name="P:System.Threading.ManualResetEventSlim.IsSet">
+ <summary>Gets whether the event is set.</summary>
+ <returns>true if the event is set; otherwise, false.</returns>
+ </member>
<member name="M:System.Threading.ManualResetEventSlim.Reset">
<summary>Sets the state of the event to nonsignaled, which causes threads to block.</summary>
<exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception>
<member name="M:System.Threading.ManualResetEventSlim.Set">
<summary>Sets the state of the event to signaled, which allows one or more threads waiting on the event to proceed.</summary>
</member>
+ <member name="P:System.Threading.ManualResetEventSlim.SpinCount">
+ <summary>Gets the number of spin waits that will occur before falling back to a kernel-based wait operation.</summary>
+ <returns>Returns the number of spin waits that will occur before falling back to a kernel-based wait operation.</returns>
+ </member>
<member name="M:System.Threading.ManualResetEventSlim.Wait">
<summary>Blocks the current thread until the current <see cref="T:System.Threading.ManualResetEventSlim" /> is set.</summary>
<exception cref="T:System.InvalidOperationException">The maximum number of waiters has been exceeded.</exception>
<member name="M:System.Threading.ManualResetEventSlim.Wait(System.Int32)">
<summary>Blocks the current thread until the current <see cref="T:System.Threading.ManualResetEventSlim" /> is set, using a 32-bit signed integer to measure the time interval.</summary>
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" />(-1) to wait indefinitely.</param>
+ <returns>
+ <see langword="true" /> if the <see cref="T:System.Threading.ManualResetEventSlim" /> was set; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.</exception>
<exception cref="T:System.InvalidOperationException">The maximum number of waiters has been exceeded.</exception>
<exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception>
- <returns>
- <see langword="true" /> if the <see cref="T:System.Threading.ManualResetEventSlim" /> was set; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Threading.ManualResetEventSlim.Wait(System.Int32,System.Threading.CancellationToken)">
<summary>Blocks the current thread until the current <see cref="T:System.Threading.ManualResetEventSlim" /> is set, using a 32-bit signed integer to measure the time interval, while observing a <see cref="T:System.Threading.CancellationToken" />.</summary>
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" />(-1) to wait indefinitely.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to observe.</param>
+ <returns>
+ <see langword="true" /> if the <see cref="T:System.Threading.ManualResetEventSlim" /> was set; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.OperationCanceledException">
+ <paramref name="cancellationToken" /> was canceled.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.</exception>
<exception cref="T:System.InvalidOperationException">The maximum number of waiters has been exceeded.</exception>
<exception cref="T:System.ObjectDisposedException">The object has already been disposed or the <see cref="T:System.Threading.CancellationTokenSource" /> that created <paramref name="cancellationToken" /> has been disposed.</exception>
- <exception cref="T:System.OperationCanceledException">
+ <exception cref="">
<paramref name="cancellationToken" /> was canceled.</exception>
- <returns>
- <see langword="true" /> if the <see cref="T:System.Threading.ManualResetEventSlim" /> was set; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Threading.ManualResetEventSlim.Wait(System.Threading.CancellationToken)">
<summary>Blocks the current thread until the current <see cref="T:System.Threading.ManualResetEventSlim" /> receives a signal, while observing a <see cref="T:System.Threading.CancellationToken" />.</summary>
<exception cref="T:System.OperationCanceledException">
<paramref name="cancellationToken" /> was canceled.</exception>
<exception cref="T:System.ObjectDisposedException">The object has already been disposed or the <see cref="T:System.Threading.CancellationTokenSource" /> that created <paramref name="cancellationToken" /> has been disposed.</exception>
- <exception cref="T:System.OperationCanceledException">
+ <exception cref="">
<paramref name="cancellationToken" /> was
- canceled.</exception>
+canceled.</exception>
</member>
<member name="M:System.Threading.ManualResetEventSlim.Wait(System.TimeSpan)">
<summary>Blocks the current thread until the current <see cref="T:System.Threading.ManualResetEventSlim" /> is set, using a <see cref="T:System.TimeSpan" /> to measure the time interval.</summary>
<param name="timeout">A <see cref="T:System.TimeSpan" /> that represents the number of milliseconds to wait, or a <see cref="T:System.TimeSpan" /> that represents -1 milliseconds to wait indefinitely.</param>
+ <returns>
+ <see langword="true" /> if the <see cref="T:System.Threading.ManualResetEventSlim" /> was set; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="timeout" /> is a negative number other than -1 milliseconds, which represents an infinite time-out.
-
- -or-
-
- The number of milliseconds in <paramref name="timeout" /> is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
+ <paramref name="timeout" /> is a negative number other than -1 milliseconds, which represents an infinite time-out.
+-or-
+The number of milliseconds in <paramref name="timeout" /> is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
<exception cref="T:System.InvalidOperationException">The maximum number of waiters has been exceeded.</exception>
<exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception>
- <returns>
- <see langword="true" /> if the <see cref="T:System.Threading.ManualResetEventSlim" /> was set; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Threading.ManualResetEventSlim.Wait(System.TimeSpan,System.Threading.CancellationToken)">
<summary>Blocks the current thread until the current <see cref="T:System.Threading.ManualResetEventSlim" /> is set, using a <see cref="T:System.TimeSpan" /> to measure the time interval, while observing a <see cref="T:System.Threading.CancellationToken" />.</summary>
<param name="timeout">A <see cref="T:System.TimeSpan" /> that represents the number of milliseconds to wait, or a <see cref="T:System.TimeSpan" /> that represents -1 milliseconds to wait indefinitely.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to observe.</param>
+ <returns>
+ <see langword="true" /> if the <see cref="T:System.Threading.ManualResetEventSlim" /> was set; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.OperationCanceledException">
+ <paramref name="cancellationToken" /> was canceled.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="timeout" /> is a negative number other than -1 milliseconds, which represents an infinite time-out.
-
- -or-
-
- The number of milliseconds in <paramref name="timeout" /> is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
+ <paramref name="timeout" /> is a negative number other than -1 milliseconds, which represents an infinite time-out.
+-or-
+The number of milliseconds in <paramref name="timeout" /> is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
<exception cref="T:System.InvalidOperationException">The maximum number of waiters has been exceeded.</exception>
<exception cref="T:System.ObjectDisposedException">The object has already been disposed or the <see cref="T:System.Threading.CancellationTokenSource" /> that created <paramref name="cancellationToken" /> has been disposed.</exception>
- <exception cref="T:System.OperationCanceledException">
+ <exception cref="">
<paramref name="cancellationToken" /> was canceled.</exception>
- <returns>
- <see langword="true" /> if the <see cref="T:System.Threading.ManualResetEventSlim" /> was set; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Threading.ManualResetEventSlim.IsSet">
- <summary>Gets whether the event is set.</summary>
- <returns>true if the event is set; otherwise, false.</returns>
- </member>
- <member name="P:System.Threading.ManualResetEventSlim.SpinCount">
- <summary>Gets the number of spin waits that will occur before falling back to a kernel-based wait operation.</summary>
- <returns>Returns the number of spin waits that will occur before falling back to a kernel-based wait operation.</returns>
</member>
<member name="P:System.Threading.ManualResetEventSlim.WaitHandle">
<summary>Gets the underlying <see cref="T:System.Threading.WaitHandle" /> object for this <see cref="T:System.Threading.ManualResetEventSlim" />.</summary>
- <returns>The underlying <see cref="T:System.Threading.WaitHandle" /> event object for this <see cref="T:System.Threading.ManualResetEventSlim" />.</returns>
+ <returns>The underlying <see cref="T:System.Threading.WaitHandle" /> event object fore this <see cref="T:System.Threading.ManualResetEventSlim" />.</returns>
</member>
<member name="T:System.Threading.Monitor">
<summary>Provides a mechanism that synchronizes access to objects.</summary>
<member name="M:System.Threading.Monitor.Enter(System.Object,System.Boolean@)">
<summary>Acquires an exclusive lock on the specified object, and atomically sets a value that indicates whether the lock was taken.</summary>
<param name="obj">The object on which to wait.</param>
- <param name="lockTaken">The result of the attempt to acquire the lock, passed by reference. The input must be <see langword="false" />. The output is <see langword="true" /> if the lock is acquired; otherwise, the output is <see langword="false" />. The output is set even if an exception occurs during the attempt to acquire the lock.
-
- Note If no exception occurs, the output of this method is always <see langword="true" />.</param>
+ <param name="lockTaken">The result of the attempt to acquire the lock, passed by reference. The input must be <see langword="false" />. The output is <see langword="true" /> if the lock is acquired; otherwise, the output is <see langword="false" />. The output is set even if an exception occurs during the attempt to acquire the lock.
+Note If no exception occurs, the output of this method is always <see langword="true" />.</param>
<exception cref="T:System.ArgumentException">The input to <paramref name="lockTaken" /> is <see langword="true" />.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="obj" /> parameter is <see langword="null" />.</exception>
</member>
<member name="M:System.Threading.Monitor.IsEntered(System.Object)">
<summary>Determines whether the current thread holds the lock on the specified object.</summary>
<param name="obj">The object to test.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="obj" /> is <see langword="null" />.</exception>
<returns>
<see langword="true" /> if the current thread holds the lock on <paramref name="obj" />; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.ArgumentNullException">
+ <paramref name="obj" /> is <see langword="null" />.</exception>
+ </member>
+ <member name="P:System.Threading.Monitor.LockContentionCount">
+ <summary>Gets the number of times there was contention when trying to take the monitor's lock.</summary>
+ <returns>The number of times there was contention when trying to take the monitor's lock.</returns>
</member>
<member name="M:System.Threading.Monitor.Pulse(System.Object)">
<summary>Notifies a thread in the waiting queue of a change in the locked object's state.</summary>
<member name="M:System.Threading.Monitor.TryEnter(System.Object)">
<summary>Attempts to acquire an exclusive lock on the specified object.</summary>
<param name="obj">The object on which to acquire the lock.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="obj" /> parameter is <see langword="null" />.</exception>
<returns>
<see langword="true" /> if the current thread acquires the lock; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="obj" /> parameter is <see langword="null" />.</exception>
</member>
<member name="M:System.Threading.Monitor.TryEnter(System.Object,System.Boolean@)">
<summary>Attempts to acquire an exclusive lock on the specified object, and atomically sets a value that indicates whether the lock was taken.</summary>
<summary>Attempts, for the specified number of milliseconds, to acquire an exclusive lock on the specified object.</summary>
<param name="obj">The object on which to acquire the lock.</param>
<param name="millisecondsTimeout">The number of milliseconds to wait for the lock.</param>
+ <returns>
+ <see langword="true" /> if the current thread acquires the lock; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="obj" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="millisecondsTimeout" /> is negative, and not equal to <see cref="F:System.Threading.Timeout.Infinite" />.</exception>
- <returns>
- <see langword="true" /> if the current thread acquires the lock; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Threading.Monitor.TryEnter(System.Object,System.Int32,System.Boolean@)">
<summary>Attempts, for the specified number of milliseconds, to acquire an exclusive lock on the specified object, and atomically sets a value that indicates whether the lock was taken.</summary>
<summary>Attempts, for the specified amount of time, to acquire an exclusive lock on the specified object.</summary>
<param name="obj">The object on which to acquire the lock.</param>
<param name="timeout">A <see cref="T:System.TimeSpan" /> representing the amount of time to wait for the lock. A value of -1 millisecond specifies an infinite wait.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="obj" /> parameter is <see langword="null" />.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The value of <paramref name="timeout" /> in milliseconds is negative and is not equal to <see cref="F:System.Threading.Timeout.Infinite" /> (-1 millisecond), or is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
<returns>
<see langword="true" /> if the current thread acquires the lock; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="obj" /> parameter is <see langword="null" />.</exception>
+ <exception cref="T:System.ArgumentOutOfRangeException">The value of <paramref name="timeout" /> in milliseconds is negative and is not equal to <see cref="F:System.Threading.Timeout.Infinite" /> (-1 millisecond), or is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
</member>
<member name="M:System.Threading.Monitor.TryEnter(System.Object,System.TimeSpan,System.Boolean@)">
<summary>Attempts, for the specified amount of time, to acquire an exclusive lock on the specified object, and atomically sets a value that indicates whether the lock was taken.</summary>
<member name="M:System.Threading.Monitor.Wait(System.Object)">
<summary>Releases the lock on an object and blocks the current thread until it reacquires the lock.</summary>
<param name="obj">The object on which to wait.</param>
+ <returns>
+ <see langword="true" /> if the call returned because the caller reacquired the lock for the specified object. This method does not return if the lock is not reacquired.</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="obj" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Threading.SynchronizationLockException">The calling thread does not own the lock for the specified object.</exception>
<exception cref="T:System.Threading.ThreadInterruptedException">The thread that invokes <see langword="Wait" /> is later interrupted from the waiting state. This happens when another thread calls this thread's <see cref="M:System.Threading.Thread.Interrupt" /> method.</exception>
- <returns>
- <see langword="true" /> if the call returned because the caller reacquired the lock for the specified object. This method does not return if the lock is not reacquired.</returns>
</member>
<member name="M:System.Threading.Monitor.Wait(System.Object,System.Int32)">
<summary>Releases the lock on an object and blocks the current thread until it reacquires the lock. If the specified time-out interval elapses, the thread enters the ready queue.</summary>
<param name="obj">The object on which to wait.</param>
<param name="millisecondsTimeout">The number of milliseconds to wait before the thread enters the ready queue.</param>
+ <returns>
+ <see langword="true" /> if the lock was reacquired before the specified time elapsed; <see langword="false" /> if the lock was reacquired after the specified time elapsed. The method does not return until the lock is reacquired.</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="obj" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Threading.SynchronizationLockException">The calling thread does not own the lock for the specified object.</exception>
<exception cref="T:System.Threading.ThreadInterruptedException">The thread that invokes <see langword="Wait" /> is later interrupted from the waiting state. This happens when another thread calls this thread's <see cref="M:System.Threading.Thread.Interrupt" /> method.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value of the <paramref name="millisecondsTimeout" /> parameter is negative, and is not equal to <see cref="F:System.Threading.Timeout.Infinite" />.</exception>
- <returns>
- <see langword="true" /> if the lock was reacquired before the specified time elapsed; <see langword="false" /> if the lock was reacquired after the specified time elapsed. The method does not return until the lock is reacquired.</returns>
</member>
<member name="M:System.Threading.Monitor.Wait(System.Object,System.Int32,System.Boolean)">
<summary>Releases the lock on an object and blocks the current thread until it reacquires the lock. If the specified time-out interval elapses, the thread enters the ready queue. This method also specifies whether the synchronization domain for the context (if in a synchronized context) is exited before the wait and reacquired afterward.</summary>
<param name="millisecondsTimeout">The number of milliseconds to wait before the thread enters the ready queue.</param>
<param name="exitContext">
<see langword="true" /> to exit and reacquire the synchronization domain for the context (if in a synchronized context) before the wait; otherwise, <see langword="false" />.</param>
+ <returns>
+ <see langword="true" /> if the lock was reacquired before the specified time elapsed; <see langword="false" /> if the lock was reacquired after the specified time elapsed. The method does not return until the lock is reacquired.</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="obj" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Threading.SynchronizationLockException">
<see langword="Wait" /> is not invoked from within a synchronized block of code.</exception>
<exception cref="T:System.Threading.ThreadInterruptedException">The thread that invokes <see langword="Wait" /> is later interrupted from the waiting state. This happens when another thread calls this thread's <see cref="M:System.Threading.Thread.Interrupt" /> method.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value of the <paramref name="millisecondsTimeout" /> parameter is negative, and is not equal to <see cref="F:System.Threading.Timeout.Infinite" />.</exception>
- <returns>
- <see langword="true" /> if the lock was reacquired before the specified time elapsed; <see langword="false" /> if the lock was reacquired after the specified time elapsed. The method does not return until the lock is reacquired.</returns>
</member>
<member name="M:System.Threading.Monitor.Wait(System.Object,System.TimeSpan)">
<summary>Releases the lock on an object and blocks the current thread until it reacquires the lock. If the specified time-out interval elapses, the thread enters the ready queue.</summary>
<param name="obj">The object on which to wait.</param>
<param name="timeout">A <see cref="T:System.TimeSpan" /> representing the amount of time to wait before the thread enters the ready queue.</param>
+ <returns>
+ <see langword="true" /> if the lock was reacquired before the specified time elapsed; <see langword="false" /> if the lock was reacquired after the specified time elapsed. The method does not return until the lock is reacquired.</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="obj" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Threading.SynchronizationLockException">The calling thread does not own the lock for the specified object.</exception>
<exception cref="T:System.Threading.ThreadInterruptedException">The thread that invokes <see langword="Wait" /> is later interrupted from the waiting state. This happens when another thread calls this thread's <see cref="M:System.Threading.Thread.Interrupt" /> method.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value of the <paramref name="timeout" /> parameter in milliseconds is negative and does not represent <see cref="F:System.Threading.Timeout.Infinite" /> (-1 millisecond), or is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
- <returns>
- <see langword="true" /> if the lock was reacquired before the specified time elapsed; <see langword="false" /> if the lock was reacquired after the specified time elapsed. The method does not return until the lock is reacquired.</returns>
</member>
<member name="M:System.Threading.Monitor.Wait(System.Object,System.TimeSpan,System.Boolean)">
<summary>Releases the lock on an object and blocks the current thread until it reacquires the lock. If the specified time-out interval elapses, the thread enters the ready queue. Optionally exits the synchronization domain for the synchronized context before the wait and reacquires the domain afterward.</summary>
<param name="timeout">A <see cref="T:System.TimeSpan" /> representing the amount of time to wait before the thread enters the ready queue.</param>
<param name="exitContext">
<see langword="true" /> to exit and reacquire the synchronization domain for the context (if in a synchronized context) before the wait; otherwise, <see langword="false" />.</param>
+ <returns>
+ <see langword="true" /> if the lock was reacquired before the specified time elapsed; <see langword="false" /> if the lock was reacquired after the specified time elapsed. The method does not return until the lock is reacquired.</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="obj" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Threading.SynchronizationLockException">
<see langword="Wait" /> is not invoked from within a synchronized block of code.</exception>
<exception cref="T:System.Threading.ThreadInterruptedException">The thread that invokes Wait is later interrupted from the waiting state. This happens when another thread calls this thread's <see cref="M:System.Threading.Thread.Interrupt" /> method.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="timeout" /> parameter is negative and does not represent <see cref="F:System.Threading.Timeout.Infinite" /> (-1 millisecond), or is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
- <returns>
- <see langword="true" /> if the lock was reacquired before the specified time elapsed; <see langword="false" /> if the lock was reacquired after the specified time elapsed. The method does not return until the lock is reacquired.</returns>
- </member>
- <member name="P:System.Threading.Monitor.LockContentionCount">
- <summary>Gets the number of times there was contention when trying to take the monitor's lock.</summary>
- <returns>The number of times there was contention when trying to take the monitor's lock.</returns>
</member>
<member name="T:System.Threading.Mutex">
<summary>A synchronization primitive that can also be used for interprocess synchronization.</summary>
<summary>Initializes a new instance of the <see cref="T:System.Threading.Mutex" /> class with a Boolean value that indicates whether the calling thread should have initial ownership of the mutex, and a string that is the name of the mutex.</summary>
<param name="initiallyOwned">
<see langword="true" /> to give the calling thread initial ownership of the named system mutex if the named system mutex is created as a result of this call; otherwise, <see langword="false" />.</param>
- <param name="name">The name, if the synchronization object is to be shared with other processes; otherwise, <see langword="null" /> or an empty string. The name is case-sensitive.</param>
+ <param name="name">The name of the <see cref="T:System.Threading.Mutex" />. If the value is <see langword="null" />, the <see cref="T:System.Threading.Mutex" /> is unnamed.</param>
<exception cref="T:System.UnauthorizedAccessException">The named mutex exists and has access control security, but the user does not have <see cref="F:System.Security.AccessControl.MutexRights.FullControl" />.</exception>
- <exception cref="T:System.IO.IOException">
- <paramref name="name" /> is invalid. This can be for various reasons, including some restrictions that may be placed by the operating system, such as an unknown prefix or invalid characters. Note that the name and common prefixes "Global" and "Local" are case-sensitive.
-
--or-
-
-There was some other error. The HResult property may provide more information.</exception>
- <exception cref="T:System.IO.DirectoryNotFoundException">Windows only: <paramref name="name" /> specified an unknown namespace. See Object Names for more information.</exception>
- <exception cref="T:System.IO.PathTooLongException">The <paramref name="name" /> is too long. Length restrictions may depend on the operating system or configuration.</exception>
- <exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">A synchronization object with the provided <paramref name="name" /> cannot be created. A synchronization object of a different type might have the same name.</exception>
+ <exception cref="T:System.IO.IOException">A Win32 error occurred.</exception>
+ <exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">The named mutex cannot be created, perhaps because a wait handle of a different type has the same name.</exception>
<exception cref="T:System.ArgumentException">
- .NET Framework only: <paramref name="name" /> is longer than MAX_PATH (260 characters).</exception>
+ <paramref name="name" /> is longer than 260 characters.</exception>
</member>
<member name="M:System.Threading.Mutex.#ctor(System.Boolean,System.String,System.Boolean@)">
<summary>Initializes a new instance of the <see cref="T:System.Threading.Mutex" /> class with a Boolean value that indicates whether the calling thread should have initial ownership of the mutex, a string that is the name of the mutex, and a Boolean value that, when the method returns, indicates whether the calling thread was granted initial ownership of the mutex.</summary>
<param name="initiallyOwned">
<see langword="true" /> to give the calling thread initial ownership of the named system mutex if the named system mutex is created as a result of this call; otherwise, <see langword="false" />.</param>
- <param name="name">The name, if the synchronization object is to be shared with other processes; otherwise, <see langword="null" /> or an empty string. The name is case-sensitive.</param>
+ <param name="name">The name of the <see cref="T:System.Threading.Mutex" />. If the value is <see langword="null" />, the <see cref="T:System.Threading.Mutex" /> is unnamed.</param>
<param name="createdNew">When this method returns, contains a Boolean that is <see langword="true" /> if a local mutex was created (that is, if <paramref name="name" /> is <see langword="null" /> or an empty string) or if the specified named system mutex was created; <see langword="false" /> if the specified named system mutex already existed. This parameter is passed uninitialized.</param>
<exception cref="T:System.UnauthorizedAccessException">The named mutex exists and has access control security, but the user does not have <see cref="F:System.Security.AccessControl.MutexRights.FullControl" />.</exception>
- <exception cref="T:System.IO.IOException">
- <paramref name="name" /> is invalid. This can be for various reasons, including some restrictions that may be placed by the operating system, such as an unknown prefix or invalid characters. Note that the name and common prefixes "Global" and "Local" are case-sensitive.
-
--or-
-
-There was some other error. The HResult property may provide more information.</exception>
- <exception cref="T:System.IO.DirectoryNotFoundException">Windows only: <paramref name="name" /> specified an unknown namespace. See Object Names for more information.</exception>
- <exception cref="T:System.IO.PathTooLongException">The <paramref name="name" /> is too long. Length restrictions may depend on the operating system or configuration.</exception>
- <exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">A synchronization object with the provided <paramref name="name" /> cannot be created. A synchronization object of a different type might have the same name.</exception>
+ <exception cref="T:System.IO.IOException">A Win32 error occurred.</exception>
+ <exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">The named mutex cannot be created, perhaps because a wait handle of a different type has the same name.</exception>
<exception cref="T:System.ArgumentException">
- .NET Framework only: <paramref name="name" /> is longer than MAX_PATH (260 characters).</exception>
+ <paramref name="name" /> is longer than 260 characters.</exception>
</member>
<member name="M:System.Threading.Mutex.OpenExisting(System.String)">
<summary>Opens the specified named mutex, if it already exists.</summary>
- <param name="name">The name of the synchronization object to be shared with other processes. The name is case-sensitive.</param>
+ <param name="name">The name of the system mutex to open.</param>
+ <returns>An object that represents the named system mutex.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="name" /> is an empty string.
-
-or-
-
-.NET Framework only: <paramref name="name" /> is longer than MAX_PATH (260 characters).</exception>
+<paramref name="name" /> is longer than 260 characters.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> is <see langword="null" />.</exception>
- <exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">A synchronization object with the provided <paramref name="name" /> cannot be created. A synchronization object of a different type might have the same name. In some cases, this exception may be thrown for invalid names.</exception>
- <exception cref="T:System.IO.IOException">
- <paramref name="name" /> is invalid. This can be for various reasons, including some restrictions that may be placed by the operating system, such as an unknown prefix or invalid characters. Note that the name and common prefixes "Global" and "Local" are case-sensitive.
-
--or-
-
-There was some other error. The HResult property may provide more information.</exception>
- <exception cref="T:System.IO.DirectoryNotFoundException">Windows only: <paramref name="name" /> specified an unknown namespace. See Object Names for more information.</exception>
- <exception cref="T:System.IO.PathTooLongException">The <paramref name="name" /> is too long. Length restrictions may depend on the operating system or configuration.</exception>
+ <exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">The named mutex does not exist.</exception>
+ <exception cref="T:System.IO.IOException">A Win32 error occurred.</exception>
<exception cref="T:System.UnauthorizedAccessException">The named mutex exists, but the user does not have the security access required to use it.</exception>
- <returns>An object that represents the named system mutex.</returns>
</member>
<member name="M:System.Threading.Mutex.ReleaseMutex">
<summary>Releases the <see cref="T:System.Threading.Mutex" /> once.</summary>
</member>
<member name="M:System.Threading.Mutex.TryOpenExisting(System.String,System.Threading.Mutex@)">
<summary>Opens the specified named mutex, if it already exists, and returns a value that indicates whether the operation succeeded.</summary>
- <param name="name">The name of the synchronization object to be shared with other processes. The name is case-sensitive.</param>
+ <param name="name">The name of the system mutex to open.</param>
<param name="result">When this method returns, contains a <see cref="T:System.Threading.Mutex" /> object that represents the named mutex if the call succeeded, or <see langword="null" /> if the call failed. This parameter is treated as uninitialized.</param>
+ <returns>
+ <see langword="true" /> if the named mutex was opened successfully; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="name" /> is an empty string.
-
-or-
-
-.NET Framework only: <paramref name="name" /> is longer than MAX_PATH (260 characters).</exception>
+<paramref name="name" /> is longer than 260 characters.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> is <see langword="null" />.</exception>
- <exception cref="T:System.IO.IOException">
- <paramref name="name" /> is invalid. This can be for various reasons, including some restrictions that may be placed by the operating system, such as an unknown prefix or invalid characters. Note that the name and common prefixes "Global" and "Local" are case-sensitive. For some invalid names, the method may return <see langword="false" /> instead.
-
--or-
-
-There was some other error. The HResult property may provide more information.</exception>
- <exception cref="T:System.IO.PathTooLongException">The <paramref name="name" /> is too long. Length restrictions may depend on the operating system or configuration.</exception>
+ <exception cref="T:System.IO.IOException">A Win32 error occurred.</exception>
<exception cref="T:System.UnauthorizedAccessException">The named mutex exists, but the user does not have the security access required to use it.</exception>
- <returns>
- <see langword="true" /> if the named mutex was opened successfully; otherwise, <see langword="false" />. In some cases, <see langword="false" /> may be returned for invalid names.</returns>
</member>
<member name="T:System.Threading.ReaderWriterLock">
<summary>Defines a lock that supports single writers and multiple readers.</summary>
<exception cref="T:System.ApplicationException">The thread does not have the writer lock.</exception>
<exception cref="T:System.NullReferenceException">The address of <paramref name="lockCookie" /> is a null pointer.</exception>
</member>
+ <member name="P:System.Threading.ReaderWriterLock.IsReaderLockHeld">
+ <summary>Gets a value indicating whether the current thread holds a reader lock.</summary>
+ <returns>
+ <see langword="true" /> if the current thread holds a reader lock; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Threading.ReaderWriterLock.IsWriterLockHeld">
+ <summary>Gets a value indicating whether the current thread holds the writer lock.</summary>
+ <returns>
+ <see langword="true" /> if the current thread holds the writer lock; otherwise, <see langword="false" />.</returns>
+ </member>
<member name="M:System.Threading.ReaderWriterLock.ReleaseLock">
<summary>Releases the lock, regardless of the number of times the thread acquired the lock.</summary>
<returns>A <see cref="T:System.Threading.LockCookie" /> value representing the released lock.</returns>
<exception cref="T:System.NullReferenceException">The address of <paramref name="lockCookie" /> is a null pointer.</exception>
</member>
<member name="M:System.Threading.ReaderWriterLock.UpgradeToWriterLock(System.Int32)">
- <summary>Upgrades a reader lock to the writer lock, using an <see cref="T:System.Int32" /> value for the time-out.</summary>
+ <summary>Upgrades a reader lock to the writer lock, using an <see langword="Int32" /> value for the time-out.</summary>
<param name="millisecondsTimeout">The time-out in milliseconds.</param>
+ <returns>A <see cref="T:System.Threading.LockCookie" /> value.</returns>
<exception cref="T:System.ApplicationException">
<paramref name="millisecondsTimeout" /> expires before the lock request is granted.</exception>
- <returns>A <see cref="T:System.Threading.LockCookie" /> value.</returns>
</member>
<member name="M:System.Threading.ReaderWriterLock.UpgradeToWriterLock(System.TimeSpan)">
<summary>Upgrades a reader lock to the writer lock, using a <see langword="TimeSpan" /> value for the time-out.</summary>
<param name="timeout">The <see langword="TimeSpan" /> specifying the time-out period.</param>
+ <returns>A <see cref="T:System.Threading.LockCookie" /> value.</returns>
<exception cref="T:System.ApplicationException">
<paramref name="timeout" /> expires before the lock request is granted.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="timeout" /> specifies a negative value other than -1 milliseconds.</exception>
- <returns>A <see cref="T:System.Threading.LockCookie" /> value.</returns>
- </member>
- <member name="P:System.Threading.ReaderWriterLock.IsReaderLockHeld">
- <summary>Gets a value indicating whether the current thread holds a reader lock.</summary>
- <returns>
- <see langword="true" /> if the current thread holds a reader lock; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Threading.ReaderWriterLock.IsWriterLockHeld">
- <summary>Gets a value indicating whether the current thread holds the writer lock.</summary>
- <returns>
- <see langword="true" /> if the current thread holds the writer lock; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.Threading.ReaderWriterLock.WriterSeqNum">
<summary>Gets the current sequence number.</summary>
<summary>Initializes a new instance of the <see cref="T:System.Threading.ReaderWriterLockSlim" /> class, specifying the lock recursion policy.</summary>
<param name="recursionPolicy">One of the enumeration values that specifies the lock recursion policy.</param>
</member>
+ <member name="P:System.Threading.ReaderWriterLockSlim.CurrentReadCount">
+ <summary>Gets the total number of unique threads that have entered the lock in read mode.</summary>
+ <returns>The number of unique threads that have entered the lock in read mode.</returns>
+ </member>
<member name="M:System.Threading.ReaderWriterLockSlim.Dispose">
<summary>Releases all resources used by the current instance of the <see cref="T:System.Threading.ReaderWriterLockSlim" /> class.</summary>
<exception cref="T:System.Threading.SynchronizationLockException">
- <see cref="P:System.Threading.ReaderWriterLockSlim.WaitingReadCount" /> is greater than zero.
-
- -or-
-
- <see cref="P:System.Threading.ReaderWriterLockSlim.WaitingUpgradeCount" /> is greater than zero.
-
- -or-
-
- <see cref="P:System.Threading.ReaderWriterLockSlim.WaitingWriteCount" /> is greater than zero.</exception>
+ <see cref="P:System.Threading.ReaderWriterLockSlim.WaitingReadCount" /> is greater than zero.
+-or-
+<see cref="P:System.Threading.ReaderWriterLockSlim.WaitingUpgradeCount" /> is greater than zero.
+-or-
+<see cref="P:System.Threading.ReaderWriterLockSlim.WaitingWriteCount" /> is greater than zero.</exception>
</member>
<member name="M:System.Threading.ReaderWriterLockSlim.EnterReadLock">
<summary>Tries to enter the lock in read mode.</summary>
- <exception cref="T:System.Threading.LockRecursionException">The <see cref="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy" /> property is <see cref="F:System.Threading.LockRecursionPolicy.NoRecursion" />, and the current thread has attempted to acquire the read lock when it already holds the read lock.
-
- -or-
-
- The <see cref="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy" /> property is <see cref="F:System.Threading.LockRecursionPolicy.NoRecursion" />, and the current thread has attempted to acquire the read lock when it already holds the write lock.
-
- -or-
-
- The recursion number would exceed the capacity of the counter. This limit is so large that applications should never encounter this exception.</exception>
+ <exception cref="T:System.Threading.LockRecursionException">The <see cref="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy" /> property is <see cref="F:System.Threading.LockRecursionPolicy.NoRecursion" />, and the current thread has attempted to acquire the read lock when it already holds the read lock.
+-or-
+The <see cref="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy" /> property is <see cref="F:System.Threading.LockRecursionPolicy.NoRecursion" />, and the current thread has attempted to acquire the read lock when it already holds the write lock.
+-or-
+The recursion number would exceed the capacity of the counter. This limit is so large that applications should never encounter this exception.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.ReaderWriterLockSlim" /> object has been disposed.</exception>
</member>
<member name="M:System.Threading.ReaderWriterLockSlim.EnterUpgradeableReadLock">
<summary>Tries to enter the lock in upgradeable mode.</summary>
- <exception cref="T:System.Threading.LockRecursionException">The <see cref="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy" /> property is <see cref="F:System.Threading.LockRecursionPolicy.NoRecursion" /> and the current thread has already entered the lock in any mode.
-
- -or-
-
- The current thread has entered read mode, so trying to enter upgradeable mode would create the possibility of a deadlock.
-
- -or-
-
- The recursion number would exceed the capacity of the counter. The limit is so large that applications should never encounter it.</exception>
+ <exception cref="T:System.Threading.LockRecursionException">The <see cref="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy" /> property is <see cref="F:System.Threading.LockRecursionPolicy.NoRecursion" /> and the current thread has already entered the lock in any mode.
+-or-
+The current thread has entered read mode, so trying to enter upgradeable mode would create the possibility of a deadlock.
+-or-
+The recursion number would exceed the capacity of the counter. The limit is so large that applications should never encounter it.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.ReaderWriterLockSlim" /> object has been disposed.</exception>
</member>
<member name="M:System.Threading.ReaderWriterLockSlim.EnterWriteLock">
<summary>Tries to enter the lock in write mode.</summary>
- <exception cref="T:System.Threading.LockRecursionException">The <see cref="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy" /> property is <see cref="F:System.Threading.LockRecursionPolicy.NoRecursion" /> and the current thread has already entered the lock in any mode.
-
- -or-
-
- The current thread has entered read mode and doesn't already own a write lock, so trying to enter the lock in write mode would create the possibility of a deadlock.
-
- -or-
-
- The recursion number would exceed the capacity of the counter. The limit is so large that applications should never encounter it.</exception>
+ <exception cref="T:System.Threading.LockRecursionException">The <see cref="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy" /> property is <see cref="F:System.Threading.LockRecursionPolicy.NoRecursion" /> and the current thread has already entered the lock in any mode.
+-or-
+The current thread has entered read mode and doesn't already own a write lock, so trying to enter the lock in write mode would create the possibility of a deadlock.
+-or-
+The recursion number would exceed the capacity of the counter. The limit is so large that applications should never encounter it.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.ReaderWriterLockSlim" /> object has been disposed.</exception>
</member>
<member name="M:System.Threading.ReaderWriterLockSlim.ExitReadLock">
<summary>Reduces the recursion count for write mode, and exits write mode if the resulting count is 0 (zero).</summary>
<exception cref="T:System.Threading.SynchronizationLockException">The current thread has not entered the lock in write mode.</exception>
</member>
+ <member name="P:System.Threading.ReaderWriterLockSlim.IsReadLockHeld">
+ <summary>Gets a value that indicates whether the current thread has entered the lock in read mode.</summary>
+ <returns>
+ <see langword="true" /> if the current thread has entered read mode; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Threading.ReaderWriterLockSlim.IsUpgradeableReadLockHeld">
+ <summary>Gets a value that indicates whether the current thread has entered the lock in upgradeable mode.</summary>
+ <returns>
+ <see langword="true" /> if the current thread has entered upgradeable mode; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Threading.ReaderWriterLockSlim.IsWriteLockHeld">
+ <summary>Gets a value that indicates whether the current thread has entered the lock in write mode.</summary>
+ <returns>
+ <see langword="true" /> if the current thread has entered write mode; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy">
+ <summary>Gets a value that indicates the recursion policy for the current <see cref="T:System.Threading.ReaderWriterLockSlim" /> object.</summary>
+ <returns>One of the enumeration values that specifies the lock recursion policy.</returns>
+ </member>
+ <member name="P:System.Threading.ReaderWriterLockSlim.RecursiveReadCount">
+ <summary>Gets the number of times the current thread has entered the lock in read mode, as an indication of recursion.</summary>
+ <returns>0 (zero) if the current thread has not entered read mode, 1 if the thread has entered read mode but has not entered it recursively, or n if the thread has entered the lock recursively n - 1 times.</returns>
+ </member>
+ <member name="P:System.Threading.ReaderWriterLockSlim.RecursiveUpgradeCount">
+ <summary>Gets the number of times the current thread has entered the lock in upgradeable mode, as an indication of recursion.</summary>
+ <returns>0 if the current thread has not entered upgradeable mode, 1 if the thread has entered upgradeable mode but has not entered it recursively, or n if the thread has entered upgradeable mode recursively n - 1 times.</returns>
+ </member>
+ <member name="P:System.Threading.ReaderWriterLockSlim.RecursiveWriteCount">
+ <summary>Gets the number of times the current thread has entered the lock in write mode, as an indication of recursion.</summary>
+ <returns>0 if the current thread has not entered write mode, 1 if the thread has entered write mode but has not entered it recursively, or n if the thread has entered write mode recursively n - 1 times.</returns>
+ </member>
<member name="M:System.Threading.ReaderWriterLockSlim.TryEnterReadLock(System.Int32)">
<summary>Tries to enter the lock in read mode, with an optional integer time-out.</summary>
<param name="millisecondsTimeout">The number of milliseconds to wait, or -1 (<see cref="F:System.Threading.Timeout.Infinite" />) to wait indefinitely.</param>
- <exception cref="T:System.Threading.LockRecursionException">The <see cref="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy" /> property is <see cref="F:System.Threading.LockRecursionPolicy.NoRecursion" /> and the current thread has already entered the lock.
-
- -or-
-
- The recursion number would exceed the capacity of the counter. The limit is so large that applications should never encounter it.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The value of <paramref name="millisecondsTimeout" /> is negative, but it is not equal to <see cref="F:System.Threading.Timeout.Infinite" /> (-1), which is the only negative value allowed.</exception>
- <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.ReaderWriterLockSlim" /> object has been disposed.</exception>
<returns>
<see langword="true" /> if the calling thread entered read mode, otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.Threading.LockRecursionException">The <see cref="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy" /> property is <see cref="F:System.Threading.LockRecursionPolicy.NoRecursion" /> and the current thread has already entered the lock.
+-or-
+The recursion number would exceed the capacity of the counter. The limit is so large that applications should never encounter it.</exception>
+ <exception cref="T:System.ArgumentOutOfRangeException">The value of <paramref name="millisecondsTimeout" /> is negative, but it is not equal to <see cref="F:System.Threading.Timeout.Infinite" /> (-1), which is the only negative value allowed.</exception>
+ <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.ReaderWriterLockSlim" /> object has been disposed.</exception>
</member>
<member name="M:System.Threading.ReaderWriterLockSlim.TryEnterReadLock(System.TimeSpan)">
<summary>Tries to enter the lock in read mode, with an optional time-out.</summary>
<param name="timeout">The interval to wait, or -1 milliseconds to wait indefinitely.</param>
- <exception cref="T:System.Threading.LockRecursionException">The <see cref="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy" /> property is <see cref="F:System.Threading.LockRecursionPolicy.NoRecursion" /> and the current thread has already entered the lock.
-
- -or-
-
- The recursion number would exceed the capacity of the counter. The limit is so large that applications should never encounter it.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The value of <paramref name="timeout" /> is negative, but it is not equal to -1 milliseconds, which is the only negative value allowed.
-
- -or-
-
- The value of <paramref name="timeout" /> is greater than <see cref="F:System.Int32.MaxValue" /> milliseconds.</exception>
- <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.ReaderWriterLockSlim" /> object has been disposed.</exception>
<returns>
<see langword="true" /> if the calling thread entered read mode, otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.Threading.LockRecursionException">The <see cref="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy" /> property is <see cref="F:System.Threading.LockRecursionPolicy.NoRecursion" /> and the current thread has already entered the lock.
+-or-
+The recursion number would exceed the capacity of the counter. The limit is so large that applications should never encounter it.</exception>
+ <exception cref="T:System.ArgumentOutOfRangeException">The value of <paramref name="timeout" /> is negative, but it is not equal to -1 milliseconds, which is the only negative value allowed.
+-or-
+The value of <paramref name="timeout" /> is greater than <see cref="F:System.Int32.MaxValue" /> milliseconds.</exception>
+ <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.ReaderWriterLockSlim" /> object has been disposed.</exception>
</member>
<member name="M:System.Threading.ReaderWriterLockSlim.TryEnterUpgradeableReadLock(System.Int32)">
<summary>Tries to enter the lock in upgradeable mode, with an optional time-out.</summary>
<param name="millisecondsTimeout">The number of milliseconds to wait, or -1 (<see cref="F:System.Threading.Timeout.Infinite" />) to wait indefinitely.</param>
- <exception cref="T:System.Threading.LockRecursionException">The <see cref="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy" /> property is <see cref="F:System.Threading.LockRecursionPolicy.NoRecursion" /> and the current thread has already entered the lock.
-
- -or-
-
- The current thread initially entered the lock in read mode, and therefore trying to enter upgradeable mode would create the possibility of a deadlock.
-
- -or-
-
- The recursion number would exceed the capacity of the counter. The limit is so large that applications should never encounter it.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The value of <paramref name="millisecondsTimeout" /> is negative, but it is not equal to <see cref="F:System.Threading.Timeout.Infinite" /> (-1), which is the only negative value allowed.</exception>
- <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.ReaderWriterLockSlim" /> object has been disposed.</exception>
<returns>
<see langword="true" /> if the calling thread entered upgradeable mode, otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.Threading.LockRecursionException">The <see cref="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy" /> property is <see cref="F:System.Threading.LockRecursionPolicy.NoRecursion" /> and the current thread has already entered the lock.
+-or-
+The current thread initially entered the lock in read mode, and therefore trying to enter upgradeable mode would create the possibility of a deadlock.
+-or-
+The recursion number would exceed the capacity of the counter. The limit is so large that applications should never encounter it.</exception>
+ <exception cref="T:System.ArgumentOutOfRangeException">The value of <paramref name="millisecondsTimeout" /> is negative, but it is not equal to <see cref="F:System.Threading.Timeout.Infinite" /> (-1), which is the only negative value allowed.</exception>
+ <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.ReaderWriterLockSlim" /> object has been disposed.</exception>
</member>
<member name="M:System.Threading.ReaderWriterLockSlim.TryEnterUpgradeableReadLock(System.TimeSpan)">
<summary>Tries to enter the lock in upgradeable mode, with an optional time-out.</summary>
<param name="timeout">The interval to wait, or -1 milliseconds to wait indefinitely.</param>
- <exception cref="T:System.Threading.LockRecursionException">The <see cref="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy" /> property is <see cref="F:System.Threading.LockRecursionPolicy.NoRecursion" /> and the current thread has already entered the lock.
-
- -or-
-
- The current thread initially entered the lock in read mode, and therefore trying to enter upgradeable mode would create the possibility of a deadlock.
-
- -or-
-
- The recursion number would exceed the capacity of the counter. The limit is so large that applications should never encounter it.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The value of <paramref name="timeout" /> is negative, but it is not equal to -1 milliseconds, which is the only negative value allowed.
-
- -or-
-
- The value of <paramref name="timeout" /> is greater than <see cref="F:System.Int32.MaxValue" /> milliseconds.</exception>
- <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.ReaderWriterLockSlim" /> object has been disposed.</exception>
<returns>
<see langword="true" /> if the calling thread entered upgradeable mode, otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.Threading.LockRecursionException">The <see cref="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy" /> property is <see cref="F:System.Threading.LockRecursionPolicy.NoRecursion" /> and the current thread has already entered the lock.
+-or-
+The current thread initially entered the lock in read mode, and therefore trying to enter upgradeable mode would create the possibility of a deadlock.
+-or-
+The recursion number would exceed the capacity of the counter. The limit is so large that applications should never encounter it.</exception>
+ <exception cref="T:System.ArgumentOutOfRangeException">The value of <paramref name="timeout" /> is negative, but it is not equal to -1 milliseconds, which is the only negative value allowed.
+-or-
+The value of <paramref name="timeout" /> is greater than <see cref="F:System.Int32.MaxValue" /> milliseconds.</exception>
+ <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.ReaderWriterLockSlim" /> object has been disposed.</exception>
</member>
<member name="M:System.Threading.ReaderWriterLockSlim.TryEnterWriteLock(System.Int32)">
<summary>Tries to enter the lock in write mode, with an optional time-out.</summary>
<param name="millisecondsTimeout">The number of milliseconds to wait, or -1 (<see cref="F:System.Threading.Timeout.Infinite" />) to wait indefinitely.</param>
- <exception cref="T:System.Threading.LockRecursionException">The <see cref="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy" /> property is <see cref="F:System.Threading.LockRecursionPolicy.NoRecursion" /> and the current thread has already entered the lock.
-
- -or-
-
- The current thread initially entered the lock in read mode, and therefore trying to enter write mode would create the possibility of a deadlock.
-
- -or-
-
- The recursion number would exceed the capacity of the counter. The limit is so large that applications should never encounter it.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The value of <paramref name="millisecondsTimeout" /> is negative, but it is not equal to <see cref="F:System.Threading.Timeout.Infinite" /> (-1), which is the only negative value allowed.</exception>
- <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.ReaderWriterLockSlim" /> object has been disposed.</exception>
<returns>
<see langword="true" /> if the calling thread entered write mode, otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.Threading.LockRecursionException">The <see cref="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy" /> property is <see cref="F:System.Threading.LockRecursionPolicy.NoRecursion" /> and the current thread has already entered the lock.
+-or-
+The current thread initially entered the lock in read mode, and therefore trying to enter write mode would create the possibility of a deadlock.
+-or-
+The recursion number would exceed the capacity of the counter. The limit is so large that applications should never encounter it.</exception>
+ <exception cref="T:System.ArgumentOutOfRangeException">The value of <paramref name="millisecondsTimeout" /> is negative, but it is not equal to <see cref="F:System.Threading.Timeout.Infinite" /> (-1), which is the only negative value allowed.</exception>
+ <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.ReaderWriterLockSlim" /> object has been disposed.</exception>
</member>
<member name="M:System.Threading.ReaderWriterLockSlim.TryEnterWriteLock(System.TimeSpan)">
<summary>Tries to enter the lock in write mode, with an optional time-out.</summary>
<param name="timeout">The interval to wait, or -1 milliseconds to wait indefinitely.</param>
- <exception cref="T:System.Threading.LockRecursionException">The <see cref="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy" /> property is <see cref="F:System.Threading.LockRecursionPolicy.NoRecursion" /> and the current thread has already entered the lock.
-
- -or-
-
- The current thread initially entered the lock in read mode, and therefore trying to enter write mode would create the possibility of a deadlock.
-
- -or-
-
- The recursion number would exceed the capacity of the counter. The limit is so large that applications should never encounter it.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The value of <paramref name="timeout" /> is negative, but it is not equal to -1 milliseconds, which is the only negative value allowed.
-
- -or-
-
- The value of <paramref name="timeout" /> is greater than <see cref="F:System.Int32.MaxValue" /> milliseconds.</exception>
- <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.ReaderWriterLockSlim" /> object has been disposed.</exception>
<returns>
<see langword="true" /> if the calling thread entered write mode, otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Threading.ReaderWriterLockSlim.CurrentReadCount">
- <summary>Gets the total number of unique threads that have entered the lock in read mode.</summary>
- <returns>The number of unique threads that have entered the lock in read mode.</returns>
- </member>
- <member name="P:System.Threading.ReaderWriterLockSlim.IsReadLockHeld">
- <summary>Gets a value that indicates whether the current thread has entered the lock in read mode.</summary>
- <returns>
- <see langword="true" /> if the current thread has entered read mode; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Threading.ReaderWriterLockSlim.IsUpgradeableReadLockHeld">
- <summary>Gets a value that indicates whether the current thread has entered the lock in upgradeable mode.</summary>
- <returns>
- <see langword="true" /> if the current thread has entered upgradeable mode; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Threading.ReaderWriterLockSlim.IsWriteLockHeld">
- <summary>Gets a value that indicates whether the current thread has entered the lock in write mode.</summary>
- <returns>
- <see langword="true" /> if the current thread has entered write mode; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy">
- <summary>Gets a value that indicates the recursion policy for the current <see cref="T:System.Threading.ReaderWriterLockSlim" /> object.</summary>
- <returns>One of the enumeration values that specifies the lock recursion policy.</returns>
- </member>
- <member name="P:System.Threading.ReaderWriterLockSlim.RecursiveReadCount">
- <summary>Gets the number of times the current thread has entered the lock in read mode, as an indication of recursion.</summary>
- <returns>0 (zero) if the current thread has not entered read mode, 1 if the thread has entered read mode but has not entered it recursively, or n if the thread has entered the lock recursively n - 1 times.</returns>
- </member>
- <member name="P:System.Threading.ReaderWriterLockSlim.RecursiveUpgradeCount">
- <summary>Gets the number of times the current thread has entered the lock in upgradeable mode, as an indication of recursion.</summary>
- <returns>0 if the current thread has not entered upgradeable mode, 1 if the thread has entered upgradeable mode but has not entered it recursively, or n if the thread has entered upgradeable mode recursively n - 1 times.</returns>
- </member>
- <member name="P:System.Threading.ReaderWriterLockSlim.RecursiveWriteCount">
- <summary>Gets the number of times the current thread has entered the lock in write mode, as an indication of recursion.</summary>
- <returns>0 if the current thread has not entered write mode, 1 if the thread has entered write mode but has not entered it recursively, or n if the thread has entered write mode recursively n - 1 times.</returns>
+ <exception cref="T:System.Threading.LockRecursionException">The <see cref="P:System.Threading.ReaderWriterLockSlim.RecursionPolicy" /> property is <see cref="F:System.Threading.LockRecursionPolicy.NoRecursion" /> and the current thread has already entered the lock.
+-or-
+The current thread initially entered the lock in read mode, and therefore trying to enter write mode would create the possibility of a deadlock.
+-or-
+The recursion number would exceed the capacity of the counter. The limit is so large that applications should never encounter it.</exception>
+ <exception cref="T:System.ArgumentOutOfRangeException">The value of <paramref name="timeout" /> is negative, but it is not equal to -1 milliseconds, which is the only negative value allowed.
+-or-
+The value of <paramref name="timeout" /> is greater than <see cref="F:System.Int32.MaxValue" /> milliseconds.</exception>
+ <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.ReaderWriterLockSlim" /> object has been disposed.</exception>
</member>
<member name="P:System.Threading.ReaderWriterLockSlim.WaitingReadCount">
<summary>Gets the total number of threads that are waiting to enter the lock in read mode.</summary>
<exception cref="T:System.ArgumentException">
<paramref name="initialCount" /> is greater than <paramref name="maximumCount" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="maximumCount" /> is less than 1.
-
- -or-
-
- <paramref name="initialCount" /> is less than 0.</exception>
+ <paramref name="maximumCount" /> is less than 1.
+-or-
+<paramref name="initialCount" /> is less than 0.</exception>
</member>
<member name="M:System.Threading.Semaphore.#ctor(System.Int32,System.Int32,System.String)">
<summary>Initializes a new instance of the <see cref="T:System.Threading.Semaphore" /> class, specifying the initial number of entries and the maximum number of concurrent entries, and optionally specifying the name of a system semaphore object.</summary>
<param name="initialCount">The initial number of requests for the semaphore that can be granted concurrently.</param>
<param name="maximumCount">The maximum number of requests for the semaphore that can be granted concurrently.</param>
- <param name="name">The name, if the synchronization object is to be shared with other processes; otherwise, <see langword="null" /> or an empty string. The name is case-sensitive.</param>
+ <param name="name">The name of a named system semaphore object.</param>
<exception cref="T:System.ArgumentException">
<paramref name="initialCount" /> is greater than <paramref name="maximumCount" />.
-
-or-
-
-.NET Framework only: <paramref name="name" /> is longer than MAX_PATH (260 characters).</exception>
+<paramref name="name" /> is longer than 260 characters.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="maximumCount" /> is less than 1.
-
- -or-
-
- <paramref name="initialCount" /> is less than 0.</exception>
- <exception cref="T:System.IO.IOException">
- <paramref name="name" /> is invalid. This can be for various reasons, including some restrictions that may be placed by the operating system, such as an unknown prefix or invalid characters. Note that the name and common prefixes "Global" and "Local" are case-sensitive.
-
+ <paramref name="maximumCount" /> is less than 1.
-or-
-
-There was some other error. The HResult property may provide more information.</exception>
- <exception cref="T:System.IO.DirectoryNotFoundException">Windows only: <paramref name="name" /> specified an unknown namespace. See Object Names for more information.</exception>
- <exception cref="T:System.IO.PathTooLongException">The <paramref name="name" /> is too long. Length restrictions may depend on the operating system or configuration.</exception>
+<paramref name="initialCount" /> is less than 0.</exception>
+ <exception cref="T:System.IO.IOException">A Win32 error occurred.</exception>
<exception cref="T:System.UnauthorizedAccessException">The named semaphore exists and has access control security, and the user does not have <see cref="F:System.Security.AccessControl.SemaphoreRights.FullControl" />.</exception>
- <exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">A synchronization object with the provided <paramref name="name" /> cannot be created. A synchronization object of a different type might have the same name.</exception>
+ <exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">The named semaphore cannot be created, perhaps because a wait handle of a different type has the same name.</exception>
</member>
<member name="M:System.Threading.Semaphore.#ctor(System.Int32,System.Int32,System.String,System.Boolean@)">
<summary>Initializes a new instance of the <see cref="T:System.Threading.Semaphore" /> class, specifying the initial number of entries and the maximum number of concurrent entries, optionally specifying the name of a system semaphore object, and specifying a variable that receives a value indicating whether a new system semaphore was created.</summary>
<param name="initialCount">The initial number of requests for the semaphore that can be satisfied concurrently.</param>
<param name="maximumCount">The maximum number of requests for the semaphore that can be satisfied concurrently.</param>
- <param name="name">The name, if the synchronization object is to be shared with other processes; otherwise, <see langword="null" /> or an empty string. The name is case-sensitive.</param>
+ <param name="name">The name of a named system semaphore object.</param>
<param name="createdNew">When this method returns, contains <see langword="true" /> if a local semaphore was created (that is, if <paramref name="name" /> is <see langword="null" /> or an empty string) or if the specified named system semaphore was created; <see langword="false" /> if the specified named system semaphore already existed. This parameter is passed uninitialized.</param>
<exception cref="T:System.ArgumentException">
<paramref name="initialCount" /> is greater than <paramref name="maximumCount" />.
-
-or-
-
-.NET Framework only: <paramref name="name" /> is longer than MAX_PATH (260 characters).</exception>
+<paramref name="name" /> is longer than 260 characters.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="maximumCount" /> is less than 1.
-
- -or-
-
- <paramref name="initialCount" /> is less than 0.</exception>
- <exception cref="T:System.IO.IOException">
- <paramref name="name" /> is invalid. This can be for various reasons, including some restrictions that may be placed by the operating system, such as an unknown prefix or invalid characters. Note that the name and common prefixes "Global" and "Local" are case-sensitive.
-
+ <paramref name="maximumCount" /> is less than 1.
-or-
-
-There was some other error. The HResult property may provide more information.</exception>
- <exception cref="T:System.IO.DirectoryNotFoundException">Windows only: <paramref name="name" /> specified an unknown namespace. See Object Names for more information.</exception>
- <exception cref="T:System.IO.PathTooLongException">The <paramref name="name" /> is too long. Length restrictions may depend on the operating system or configuration.</exception>
+<paramref name="initialCount" /> is less than 0.</exception>
+ <exception cref="T:System.IO.IOException">A Win32 error occurred.</exception>
<exception cref="T:System.UnauthorizedAccessException">The named semaphore exists and has access control security, and the user does not have <see cref="F:System.Security.AccessControl.SemaphoreRights.FullControl" />.</exception>
- <exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">A synchronization object with the provided <paramref name="name" /> cannot be created. A synchronization object of a different type might have the same name.</exception>
+ <exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">The named semaphore cannot be created, perhaps because a wait handle of a different type has the same name.</exception>
</member>
<member name="M:System.Threading.Semaphore.OpenExisting(System.String)">
<summary>Opens the specified named semaphore, if it already exists.</summary>
- <param name="name">The name of the synchronization object to be shared with other processes. The name is case-sensitive.</param>
+ <param name="name">The name of the system semaphore to open.</param>
+ <returns>An object that represents the named system semaphore.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="name" /> is an empty string.
-
-or-
-
-.NET Framework only: <paramref name="name" /> is longer than MAX_PATH (260 characters).</exception>
+<paramref name="name" /> is longer than 260 characters.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> is <see langword="null" />.</exception>
- <exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">A synchronization object with the provided <paramref name="name" /> cannot be created. A synchronization object of a different type might have the same name. In some cases, this exception may be thrown for invalid names.</exception>
- <exception cref="T:System.IO.IOException">
- <paramref name="name" /> is invalid. This can be for various reasons, including some restrictions that may be placed by the operating system, such as an unknown prefix or invalid characters. Note that the name and common prefixes "Global" and "Local" are case-sensitive.
-
--or-
-
-There was some other error. The HResult property may provide more information.</exception>
- <exception cref="T:System.IO.PathTooLongException">The <paramref name="name" /> is too long. Length restrictions may depend on the operating system or configuration.</exception>
+ <exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">The named semaphore does not exist.</exception>
+ <exception cref="T:System.IO.IOException">A Win32 error occurred.</exception>
<exception cref="T:System.UnauthorizedAccessException">The named semaphore exists, but the user does not have the security access required to use it.</exception>
- <returns>An object that represents the named system semaphore.</returns>
</member>
<member name="M:System.Threading.Semaphore.Release">
<summary>Exits the semaphore and returns the previous count.</summary>
+ <returns>The count on the semaphore before the <see cref="Overload:System.Threading.Semaphore.Release" /> method was called.</returns>
<exception cref="T:System.Threading.SemaphoreFullException">The semaphore count is already at the maximum value.</exception>
<exception cref="T:System.IO.IOException">A Win32 error occurred with a named semaphore.</exception>
- <exception cref="T:System.UnauthorizedAccessException">The current semaphore represents a named system semaphore, but the user does not have <see cref="F:System.Security.AccessControl.SemaphoreRights.Modify" />.
-
- -or-
-
- The current semaphore represents a named system semaphore, but it was not opened with <see cref="F:System.Security.AccessControl.SemaphoreRights.Modify" />.</exception>
- <returns>The count on the semaphore before the <see cref="Overload:System.Threading.Semaphore.Release" /> method was called.</returns>
+ <exception cref="T:System.UnauthorizedAccessException">The current semaphore represents a named system semaphore, but the user does not have <see cref="F:System.Security.AccessControl.SemaphoreRights.Modify" />.
+-or-
+The current semaphore represents a named system semaphore, but it was not opened with <see cref="F:System.Security.AccessControl.SemaphoreRights.Modify" />.</exception>
</member>
<member name="M:System.Threading.Semaphore.Release(System.Int32)">
<summary>Exits the semaphore a specified number of times and returns the previous count.</summary>
<param name="releaseCount">The number of times to exit the semaphore.</param>
+ <returns>The count on the semaphore before the <see cref="Overload:System.Threading.Semaphore.Release" /> method was called.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="releaseCount" /> is less than 1.</exception>
<exception cref="T:System.Threading.SemaphoreFullException">The semaphore count is already at the maximum value.</exception>
<exception cref="T:System.IO.IOException">A Win32 error occurred with a named semaphore.</exception>
- <exception cref="T:System.UnauthorizedAccessException">The current semaphore represents a named system semaphore, but the user does not have <see cref="F:System.Security.AccessControl.SemaphoreRights.Modify" /> rights.
-
- -or-
-
- The current semaphore represents a named system semaphore, but it was not opened with <see cref="F:System.Security.AccessControl.SemaphoreRights.Modify" /> rights.</exception>
- <returns>The count on the semaphore before the <see cref="Overload:System.Threading.Semaphore.Release" /> method was called.</returns>
+ <exception cref="T:System.UnauthorizedAccessException">The current semaphore represents a named system semaphore, but the user does not have <see cref="F:System.Security.AccessControl.SemaphoreRights.Modify" /> rights.
+-or-
+The current semaphore represents a named system semaphore, but it was not opened with <see cref="F:System.Security.AccessControl.SemaphoreRights.Modify" /> rights.</exception>
</member>
<member name="M:System.Threading.Semaphore.TryOpenExisting(System.String,System.Threading.Semaphore@)">
<summary>Opens the specified named semaphore, if it already exists, and returns a value that indicates whether the operation succeeded.</summary>
- <param name="name">The name of the synchronization object to be shared with other processes. The name is case-sensitive.</param>
+ <param name="name">The name of the system semaphore to open.</param>
<param name="result">When this method returns, contains a <see cref="T:System.Threading.Semaphore" /> object that represents the named semaphore if the call succeeded, or <see langword="null" /> if the call failed. This parameter is treated as uninitialized.</param>
+ <returns>
+ <see langword="true" /> if the named semaphore was opened successfully; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="name" /> is an empty string.
-
-or-
-
-.NET Framework only: <paramref name="name" /> is longer than MAX_PATH (260 characters).</exception>
+<paramref name="name" /> is longer than 260 characters.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> is <see langword="null" />.</exception>
- <exception cref="T:System.IO.IOException">
- <paramref name="name" /> is invalid. This can be for various reasons, including some restrictions that may be placed by the operating system, such as an unknown prefix or invalid characters. Note that the name and common prefixes "Global" and "Local" are case-sensitive. For some invalid names, the method may return <see langword="false" /> instead.
-
--or-
-
-There was some other error. The HResult property may provide more information.</exception>
- <exception cref="T:System.IO.PathTooLongException">The <paramref name="name" /> is too long. Length restrictions may depend on the operating system or configuration.</exception>
+ <exception cref="T:System.IO.IOException">A Win32 error occurred.</exception>
<exception cref="T:System.UnauthorizedAccessException">The named semaphore exists, but the user does not have the security access required to use it.</exception>
- <returns>
- <see langword="true" /> if the named semaphore was opened successfully; otherwise, <see langword="false" />. In some cases, <see langword="false" /> may be returned for invalid names.</returns>
</member>
<member name="T:System.Threading.SemaphoreFullException">
<summary>The exception that is thrown when the <see cref="Overload:System.Threading.Semaphore.Release" /> method is called on a semaphore whose count is already at the maximum.</summary>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="initialCount" /> is less than 0, or <paramref name="initialCount" /> is greater than <paramref name="maxCount" />, or <paramref name="maxCount" /> is equal to or less than 0.</exception>
</member>
+ <member name="P:System.Threading.SemaphoreSlim.AvailableWaitHandle">
+ <summary>Returns a <see cref="T:System.Threading.WaitHandle" /> that can be used to wait on the semaphore.</summary>
+ <returns>A <see cref="T:System.Threading.WaitHandle" /> that can be used to wait on the semaphore.</returns>
+ <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.SemaphoreSlim" /> has been disposed.</exception>
+ </member>
+ <member name="P:System.Threading.SemaphoreSlim.CurrentCount">
+ <summary>Gets the number of remaining threads that can enter the <see cref="T:System.Threading.SemaphoreSlim" /> object.</summary>
+ <returns>The number of remaining threads that can enter the semaphore.</returns>
+ </member>
<member name="M:System.Threading.SemaphoreSlim.Dispose">
<summary>Releases all resources used by the current instance of the <see cref="T:System.Threading.SemaphoreSlim" /> class.</summary>
</member>
</member>
<member name="M:System.Threading.SemaphoreSlim.Release">
<summary>Releases the <see cref="T:System.Threading.SemaphoreSlim" /> object once.</summary>
+ <returns>The previous count of the <see cref="T:System.Threading.SemaphoreSlim" />.</returns>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
<exception cref="T:System.Threading.SemaphoreFullException">The <see cref="T:System.Threading.SemaphoreSlim" /> has already reached its maximum size.</exception>
- <returns>The previous count of the <see cref="T:System.Threading.SemaphoreSlim" />.</returns>
</member>
<member name="M:System.Threading.SemaphoreSlim.Release(System.Int32)">
<summary>Releases the <see cref="T:System.Threading.SemaphoreSlim" /> object a specified number of times.</summary>
<param name="releaseCount">The number of times to exit the semaphore.</param>
+ <returns>The previous count of the <see cref="T:System.Threading.SemaphoreSlim" />.</returns>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="releaseCount" /> is less than 1.</exception>
<exception cref="T:System.Threading.SemaphoreFullException">The <see cref="T:System.Threading.SemaphoreSlim" /> has already reached its maximum size.</exception>
- <returns>The previous count of the <see cref="T:System.Threading.SemaphoreSlim" />.</returns>
</member>
<member name="M:System.Threading.SemaphoreSlim.Wait">
<summary>Blocks the current thread until it can enter the <see cref="T:System.Threading.SemaphoreSlim" />.</summary>
<member name="M:System.Threading.SemaphoreSlim.Wait(System.Int32)">
<summary>Blocks the current thread until it can enter the <see cref="T:System.Threading.SemaphoreSlim" />, using a 32-bit signed integer that specifies the timeout.</summary>
<param name="millisecondsTimeout">The number of milliseconds to wait, <see cref="F:System.Threading.Timeout.Infinite" />(-1) to wait indefinitely, or zero to test the state of the wait handle and return immediately.</param>
+ <returns>
+ <see langword="true" /> if the current thread successfully entered the <see cref="T:System.Threading.SemaphoreSlim" />; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite timeout -or- timeout is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.SemaphoreSlim" /> has been disposed.</exception>
- <returns>
- <see langword="true" /> if the current thread successfully entered the <see cref="T:System.Threading.SemaphoreSlim" />; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Threading.SemaphoreSlim.Wait(System.Int32,System.Threading.CancellationToken)">
<summary>Blocks the current thread until it can enter the <see cref="T:System.Threading.SemaphoreSlim" />, using a 32-bit signed integer that specifies the timeout, while observing a <see cref="T:System.Threading.CancellationToken" />.</summary>
<param name="millisecondsTimeout">The number of milliseconds to wait, <see cref="F:System.Threading.Timeout.Infinite" />(-1) to wait indefinitely, or zero to test the state of the wait handle and return immediately.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to observe.</param>
+ <returns>
+ <see langword="true" /> if the current thread successfully entered the <see cref="T:System.Threading.SemaphoreSlim" />; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.OperationCanceledException">
<paramref name="cancellationToken" /> was canceled.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite timeout.
-
--or-
-
-<paramref name="millisecondsTimeout" /> is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
+ <paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite timeout -or- timeout is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.SemaphoreSlim" /> instance has been disposed, or the <see cref="T:System.Threading.CancellationTokenSource" /> that created <paramref name="cancellationToken" /> has been disposed.</exception>
- <returns>
- <see langword="true" /> if the current thread successfully entered the <see cref="T:System.Threading.SemaphoreSlim" />; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Threading.SemaphoreSlim.Wait(System.Threading.CancellationToken)">
<summary>Blocks the current thread until it can enter the <see cref="T:System.Threading.SemaphoreSlim" />, while observing a <see cref="T:System.Threading.CancellationToken" />.</summary>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> token to observe.</param>
<exception cref="T:System.OperationCanceledException">
<paramref name="cancellationToken" /> was canceled.</exception>
- <exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.
-
- -or-
-
- The <see cref="T:System.Threading.CancellationTokenSource" /> that created <paramref name="cancellationToken" /> has already been disposed.</exception>
+ <exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.
+-or-
+The <see cref="T:System.Threading.CancellationTokenSource" /> that created <paramref name="cancellationToken" /> has already been disposed.</exception>
</member>
<member name="M:System.Threading.SemaphoreSlim.Wait(System.TimeSpan)">
<summary>Blocks the current thread until it can enter the <see cref="T:System.Threading.SemaphoreSlim" />, using a <see cref="T:System.TimeSpan" /> to specify the timeout.</summary>
<param name="timeout">A <see cref="T:System.TimeSpan" /> that represents the number of milliseconds to wait, a <see cref="T:System.TimeSpan" /> that represents -1 milliseconds to wait indefinitely, or a <see cref="T:System.TimeSpan" /> that represents 0 milliseconds to test the wait handle and return immediately.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="timeout" /> is a negative number other than -1, which represents an infinite timeout.
-
--or-
-
-<paramref name="timeout" /> is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
- <exception cref="T:System.ObjectDisposedException">The semaphoreSlim instance has been disposed.</exception>
<returns>
<see langword="true" /> if the current thread successfully entered the <see cref="T:System.Threading.SemaphoreSlim" />; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.ArgumentOutOfRangeException">
+ <paramref name="timeout" /> is a negative number other than -1, which represents an infinite timeout -or- timeout is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
+ <exception cref="T:System.ObjectDisposedException">The semaphoreSlim instance has been disposed <paramref name="." /></exception>
</member>
<member name="M:System.Threading.SemaphoreSlim.Wait(System.TimeSpan,System.Threading.CancellationToken)">
<summary>Blocks the current thread until it can enter the <see cref="T:System.Threading.SemaphoreSlim" />, using a <see cref="T:System.TimeSpan" /> that specifies the timeout, while observing a <see cref="T:System.Threading.CancellationToken" />.</summary>
<param name="timeout">A <see cref="T:System.TimeSpan" /> that represents the number of milliseconds to wait, a <see cref="T:System.TimeSpan" /> that represents -1 milliseconds to wait indefinitely, or a <see cref="T:System.TimeSpan" /> that represents 0 milliseconds to test the wait handle and return immediately.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to observe.</param>
+ <returns>
+ <see langword="true" /> if the current thread successfully entered the <see cref="T:System.Threading.SemaphoreSlim" />; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.OperationCanceledException">
<paramref name="cancellationToken" /> was canceled.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="timeout" /> is a negative number other than -1, which represents an infinite timeout.
-
--or-.
-
-<paramref name="timeout" /> is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
- <exception cref="T:System.ObjectDisposedException">The semaphoreSlim instance has been disposed.
-
--or-
-
+ <paramref name="timeout" /> is a negative number other than -1, which represents an infinite timeout -or- timeout is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
+ <exception cref="T:System.ObjectDisposedException">The semaphoreSlim instance has been disposed <paramref name="." /><paramref name="-or-" />
The <see cref="T:System.Threading.CancellationTokenSource" /> that created <paramref name="cancellationToken" /> has already been disposed.</exception>
- <returns>
- <see langword="true" /> if the current thread successfully entered the <see cref="T:System.Threading.SemaphoreSlim" />; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Threading.SemaphoreSlim.WaitAsync">
<summary>Asynchronously waits to enter the <see cref="T:System.Threading.SemaphoreSlim" />.</summary>
- <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.SemaphoreSlim" /> has been disposed.</exception>
<returns>A task that will complete when the semaphore has been entered.</returns>
+ <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.SemaphoreSlim" /> has been disposed.</exception>
</member>
<member name="M:System.Threading.SemaphoreSlim.WaitAsync(System.Int32)">
<summary>Asynchronously waits to enter the <see cref="T:System.Threading.SemaphoreSlim" />, using a 32-bit signed integer to measure the time interval.</summary>
<param name="millisecondsTimeout">The number of milliseconds to wait, <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely, or zero to test the state of the wait handle and return immediately.</param>
+ <returns>A task that will complete with a result of <see langword="true" /> if the current thread successfully entered the <see cref="T:System.Threading.SemaphoreSlim" />, otherwise with a result of <see langword="false" />.</returns>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite timeout.
-
--or-
-
-<paramref name="millisecondsTimeout" /> is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
- <returns>A task that will complete with a result of <see langword="true" /> if the current thread successfully entered the <see cref="T:System.Threading.SemaphoreSlim" />, otherwise with a result of <see langword="false" />.</returns>
+ <paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite timeout -or- timeout is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
</member>
<member name="M:System.Threading.SemaphoreSlim.WaitAsync(System.Int32,System.Threading.CancellationToken)">
<summary>Asynchronously waits to enter the <see cref="T:System.Threading.SemaphoreSlim" />, using a 32-bit signed integer to measure the time interval, while observing a <see cref="T:System.Threading.CancellationToken" />.</summary>
<param name="millisecondsTimeout">The number of milliseconds to wait, <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely, or zero to test the state of the wait handle and return immediately.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to observe.</param>
+ <returns>A task that will complete with a result of <see langword="true" /> if the current thread successfully entered the <see cref="T:System.Threading.SemaphoreSlim" />, otherwise with a result of <see langword="false" />.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="millisecondsTimeout" /> is a number other than -1, which represents an infinite timeout.
-
--or-
-
-<paramref name="millisecondsTimeout" /> is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
+ <paramref name="millisecondsTimeout" /> is a number other than -1, which represents an infinite timeout -or- timeout is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
<exception cref="T:System.OperationCanceledException">
<paramref name="cancellationToken" /> was canceled.</exception>
- <returns>A task that will complete with a result of <see langword="true" /> if the current thread successfully entered the <see cref="T:System.Threading.SemaphoreSlim" />, otherwise with a result of <see langword="false" />.</returns>
</member>
<member name="M:System.Threading.SemaphoreSlim.WaitAsync(System.Threading.CancellationToken)">
<summary>Asynchronously waits to enter the <see cref="T:System.Threading.SemaphoreSlim" />, while observing a <see cref="T:System.Threading.CancellationToken" />.</summary>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> token to observe.</param>
+ <returns>A task that will complete when the semaphore has been entered.</returns>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
<exception cref="T:System.OperationCanceledException">
<paramref name="cancellationToken" /> was canceled.</exception>
- <returns>A task that will complete when the semaphore has been entered.</returns>
</member>
<member name="M:System.Threading.SemaphoreSlim.WaitAsync(System.TimeSpan)">
<summary>Asynchronously waits to enter the <see cref="T:System.Threading.SemaphoreSlim" />, using a <see cref="T:System.TimeSpan" /> to measure the time interval.</summary>
<param name="timeout">A <see cref="T:System.TimeSpan" /> that represents the number of milliseconds to wait, a <see cref="T:System.TimeSpan" /> that represents -1 milliseconds to wait indefinitely, or a <see cref="T:System.TimeSpan" /> that represents 0 milliseconds to test the wait handle and return immediately.</param>
+ <returns>A task that will complete with a result of <see langword="true" /> if the current thread successfully entered the <see cref="T:System.Threading.SemaphoreSlim" />, otherwise with a result of <see langword="false" />.</returns>
<exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="timeout" /> is a negative number other than -1, which represents an infinite timeout.
-
--or-
-
-<paramref name="timeout" /> is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
- <returns>A task that will complete with a result of <see langword="true" /> if the current thread successfully entered the <see cref="T:System.Threading.SemaphoreSlim" />, otherwise with a result of <see langword="false" />.</returns>
+ <paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite timeout -or- timeout is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
</member>
<member name="M:System.Threading.SemaphoreSlim.WaitAsync(System.TimeSpan,System.Threading.CancellationToken)">
<summary>Asynchronously waits to enter the <see cref="T:System.Threading.SemaphoreSlim" />, using a <see cref="T:System.TimeSpan" /> to measure the time interval, while observing a <see cref="T:System.Threading.CancellationToken" />.</summary>
<param name="timeout">A <see cref="T:System.TimeSpan" /> that represents the number of milliseconds to wait, a <see cref="T:System.TimeSpan" /> that represents -1 milliseconds to wait indefinitely, or a <see cref="T:System.TimeSpan" /> that represents 0 milliseconds to test the wait handle and return immediately.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> token to observe.</param>
+ <returns>A task that will complete with a result of <see langword="true" /> if the current thread successfully entered the <see cref="T:System.Threading.SemaphoreSlim" />, otherwise with a result of <see langword="false" />.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="timeout" /> is a negative number other than -1, which represents an infinite timeout.
-
--or-
-
-<paramref name="timeout" /> is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
+ <paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite timeout -or- timeout is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
<exception cref="T:System.OperationCanceledException">
<paramref name="cancellationToken" /> was canceled.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.SemaphoreSlim" /> has been disposed.</exception>
- <returns>A task that will complete with a result of <see langword="true" /> if the current thread successfully entered the <see cref="T:System.Threading.SemaphoreSlim" />, otherwise with a result of <see langword="false" />.</returns>
- </member>
- <member name="P:System.Threading.SemaphoreSlim.AvailableWaitHandle">
- <summary>Returns a <see cref="T:System.Threading.WaitHandle" /> that can be used to wait on the semaphore.</summary>
- <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.SemaphoreSlim" /> has been disposed.</exception>
- <returns>A <see cref="T:System.Threading.WaitHandle" /> that can be used to wait on the semaphore.</returns>
- </member>
- <member name="P:System.Threading.SemaphoreSlim.CurrentCount">
- <summary>Gets the number of remaining threads that can enter the <see cref="T:System.Threading.SemaphoreSlim" /> object.</summary>
- <returns>The number of remaining threads that can enter the semaphore.</returns>
</member>
<member name="T:System.Threading.SendOrPostCallback">
<summary>Represents a method to be called when a message is to be dispatched to a synchronization context.</summary>
<param name="useMemoryBarrier">A Boolean value that indicates whether a memory fence should be issued in order to immediately publish the exit operation to other threads.</param>
<exception cref="T:System.Threading.SynchronizationLockException">Thread ownership tracking is enabled, and the current thread is not the owner of this lock.</exception>
</member>
+ <member name="P:System.Threading.SpinLock.IsHeld">
+ <summary>Gets whether the lock is currently held by any thread.</summary>
+ <returns>true if the lock is currently held by any thread; otherwise false.</returns>
+ </member>
+ <member name="P:System.Threading.SpinLock.IsHeldByCurrentThread">
+ <summary>Gets whether the lock is held by the current thread.</summary>
+ <returns>true if the lock is held by the current thread; otherwise false.</returns>
+ <exception cref="T:System.InvalidOperationException">Thread ownership tracking is disabled.</exception>
+ </member>
+ <member name="P:System.Threading.SpinLock.IsThreadOwnerTrackingEnabled">
+ <summary>Gets whether thread ownership tracking is enabled for this instance.</summary>
+ <returns>true if thread ownership tracking is enabled for this instance; otherwise false.</returns>
+ </member>
<member name="M:System.Threading.SpinLock.TryEnter(System.Boolean@)">
<summary>Attempts to acquire the lock in a reliable manner, such that even if an exception occurs within the method call, <paramref name="lockTaken" /> can be examined reliably to determine whether the lock was acquired.</summary>
<param name="lockTaken">True if the lock is acquired; otherwise, false. <paramref name="lockTaken" /> must be initialized to false prior to calling this method.</param>
<exception cref="T:System.ArgumentException">The <paramref name="lockTaken" /> argument must be initialized to false prior to calling TryEnter.</exception>
<exception cref="T:System.Threading.LockRecursionException">Thread ownership tracking is enabled, and the current thread has already acquired this lock.</exception>
</member>
- <member name="P:System.Threading.SpinLock.IsHeld">
- <summary>Gets whether the lock is currently held by any thread.</summary>
- <returns>true if the lock is currently held by any thread; otherwise false.</returns>
- </member>
- <member name="P:System.Threading.SpinLock.IsHeldByCurrentThread">
- <summary>Gets whether the lock is held by the current thread.</summary>
- <exception cref="T:System.InvalidOperationException">Thread ownership tracking is disabled.</exception>
- <returns>true if the lock is held by the current thread; otherwise false.</returns>
- </member>
- <member name="P:System.Threading.SpinLock.IsThreadOwnerTrackingEnabled">
- <summary>Gets whether thread ownership tracking is enabled for this instance.</summary>
- <returns>true if thread ownership tracking is enabled for this instance; otherwise false.</returns>
- </member>
<member name="T:System.Threading.SpinWait">
<summary>Provides support for spin-based waiting.</summary>
</member>
+ <member name="P:System.Threading.SpinWait.Count">
+ <summary>Gets the number of times <see cref="M:System.Threading.SpinWait.SpinOnce" /> has been called on this instance.</summary>
+ <returns>Returns an integer that represents the number of times <see cref="M:System.Threading.SpinWait.SpinOnce" /> has been called on this instance.</returns>
+ </member>
+ <member name="P:System.Threading.SpinWait.NextSpinWillYield">
+ <summary>Gets whether the next call to <see cref="M:System.Threading.SpinWait.SpinOnce" /> will yield the processor, triggering a forced context switch.</summary>
+ <returns>Whether the next call to <see cref="M:System.Threading.SpinWait.SpinOnce" /> will yield the processor, triggering a forced context switch.</returns>
+ </member>
<member name="M:System.Threading.SpinWait.Reset">
<summary>Resets the spin counter.</summary>
</member>
<summary>Spins until the specified condition is satisfied or until the specified timeout is expired.</summary>
<param name="condition">A delegate to be executed over and over until it returns true.</param>
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
+ <returns>
+ <see langword="true" /> if the condition is satisfied within the timeout; otherwise, false</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="condition" /> argument is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.</exception>
- <returns>
- <see langword="true" /> if the condition is satisfied within the timeout; otherwise, false.</returns>
</member>
<member name="M:System.Threading.SpinWait.SpinUntil(System.Func{System.Boolean},System.TimeSpan)">
<summary>Spins until the specified condition is satisfied or until the specified timeout is expired.</summary>
<param name="condition">A delegate to be executed over and over until it returns true.</param>
<param name="timeout">A <see cref="T:System.TimeSpan" /> that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.</param>
+ <returns>
+ <see langword="true" /> if the condition is satisfied within the timeout; otherwise, false</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="condition" /> argument is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="timeout" /> is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
- <returns>
- <see langword="true" /> if the condition is satisfied within the timeout; otherwise, false.</returns>
- </member>
- <member name="P:System.Threading.SpinWait.Count">
- <summary>Gets the number of times <see cref="M:System.Threading.SpinWait.SpinOnce" /> has been called on this instance.</summary>
- <returns>Returns an integer that represents the number of times <see cref="M:System.Threading.SpinWait.SpinOnce" /> has been called on this instance.</returns>
- </member>
- <member name="P:System.Threading.SpinWait.NextSpinWillYield">
- <summary>Gets whether the next call to <see cref="M:System.Threading.SpinWait.SpinOnce" /> will yield the processor, triggering a forced context switch.</summary>
- <returns>Whether the next call to <see cref="M:System.Threading.SpinWait.SpinOnce" /> will yield the processor, triggering a forced context switch.</returns>
</member>
<member name="T:System.Threading.SynchronizationContext">
<summary>Provides the basic functionality for propagating a synchronization context in various synchronization models.</summary>
<summary>When overridden in a derived class, creates a copy of the synchronization context.</summary>
<returns>A new <see cref="T:System.Threading.SynchronizationContext" /> object.</returns>
</member>
+ <member name="P:System.Threading.SynchronizationContext.Current">
+ <summary>Gets the synchronization context for the current thread.</summary>
+ <returns>A <see cref="T:System.Threading.SynchronizationContext" /> object representing the current synchronization context.</returns>
+ </member>
<member name="M:System.Threading.SynchronizationContext.IsWaitNotificationRequired">
<summary>Determines if wait notification is required.</summary>
<returns>
<param name="waitAll">
<see langword="true" /> to wait for all handles; <see langword="false" /> to wait for any handle.</param>
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
+ <returns>The array index of the object that satisfied the wait.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="waitHandles" /> is null.</exception>
- <returns>The array index of the object that satisfied the wait.</returns>
</member>
<member name="M:System.Threading.SynchronizationContext.WaitHelper(System.IntPtr[],System.Boolean,System.Int32)">
<summary>Helper function that waits for any or all the elements in the specified array to receive a signal.</summary>
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
<returns>The array index of the object that satisfied the wait.</returns>
</member>
- <member name="P:System.Threading.SynchronizationContext.Current">
- <summary>Gets the synchronization context for the current thread.</summary>
- <returns>A <see cref="T:System.Threading.SynchronizationContext" /> object representing the current synchronization context.</returns>
- </member>
<member name="T:System.Threading.SynchronizationLockException">
<summary>The exception that is thrown when a method requires the caller to own the lock on a given Monitor, and the method is invoked by a caller that does not own that lock.</summary>
</member>
<member name="M:System.Threading.ThreadLocal`1.#ctor(System.Boolean)">
<summary>Initializes the <see cref="T:System.Threading.ThreadLocal`1" /> instance and specifies whether all values are accessible from any thread.</summary>
<param name="trackAllValues">
- <see langword="true" /> to track all values set on the instance and expose them through the <see cref="P:System.Threading.ThreadLocal`1.Values" /> property; <see langword="false" /> otherwise. When set to <see langword="true" />, a value stored from a given thread will be available through <see cref="P:System.Threading.ThreadLocal`1.Values" /> even after that thread has exited.</param>
+ <see langword="true" /> to track all values set on the instance and expose them through the <see cref="P:System.Threading.ThreadLocal`1.Values" /> property; <see langword="false" /> otherwise.</param>
</member>
<member name="M:System.Threading.ThreadLocal`1.#ctor(System.Func{`0})">
<summary>Initializes the <see cref="T:System.Threading.ThreadLocal`1" /> instance with the specified <paramref name="valueFactory" /> function.</summary>
<summary>Initializes the <see cref="T:System.Threading.ThreadLocal`1" /> instance with the specified <paramref name="valueFactory" /> function and a flag that indicates whether all values are accessible from any thread.</summary>
<param name="valueFactory">The <see cref="T:System.Func`1" /> invoked to produce a lazily-initialized value when an attempt is made to retrieve <see cref="P:System.Threading.ThreadLocal`1.Value" /> without it having been previously initialized.</param>
<param name="trackAllValues">
- <see langword="true" /> to track all values set on the instance and expose them through the <see cref="P:System.Threading.ThreadLocal`1.Values" /> property; <see langword="false" /> otherwise. When set to <see langword="true" />, a value stored from a given thread will be available through <see cref="P:System.Threading.ThreadLocal`1.Values" /> even after that thread has exited.</param>
+ <see langword="true" /> to track all values set on the instance and expose them through the <see cref="P:System.Threading.ThreadLocal`1.Values" /> property; <see langword="false" /> otherwise.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="valueFactory" /> is a <see langword="null" /> reference (<see langword="Nothing" /> in Visual Basic).</exception>
</member>
<member name="M:System.Threading.ThreadLocal`1.Finalize">
<summary>Releases the resources used by this <see cref="T:System.Threading.ThreadLocal`1" /> instance.</summary>
</member>
+ <member name="P:System.Threading.ThreadLocal`1.IsValueCreated">
+ <summary>Gets whether <see cref="P:System.Threading.ThreadLocal`1.Value" /> is initialized on the current thread.</summary>
+ <returns>true if <see cref="P:System.Threading.ThreadLocal`1.Value" /> is initialized on the current thread; otherwise false.</returns>
+ <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.ThreadLocal`1" /> instance has been disposed.</exception>
+ </member>
<member name="M:System.Threading.ThreadLocal`1.ToString">
<summary>Creates and returns a string representation of this instance for the current thread.</summary>
+ <returns>The result of calling <see cref="M:System.Object.ToString" /> on the <see cref="P:System.Threading.ThreadLocal`1.Value" />.</returns>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.ThreadLocal`1" /> instance has been disposed.</exception>
<exception cref="T:System.NullReferenceException">The <see cref="P:System.Threading.ThreadLocal`1.Value" /> for the current thread is a null reference (Nothing in Visual Basic).</exception>
<exception cref="T:System.InvalidOperationException">The initialization function attempted to reference <see cref="P:System.Threading.ThreadLocal`1.Value" /> recursively.</exception>
<exception cref="T:System.MissingMemberException">No parameterless constructor is provided and no value factory is supplied.</exception>
- <returns>The result of calling <see cref="M:System.Object.ToString" /> on the <see cref="P:System.Threading.ThreadLocal`1.Value" />.</returns>
- </member>
- <member name="P:System.Threading.ThreadLocal`1.IsValueCreated">
- <summary>Gets whether <see cref="P:System.Threading.ThreadLocal`1.Value" /> is initialized on the current thread.</summary>
- <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.ThreadLocal`1" /> instance has been disposed.</exception>
- <returns>true if <see cref="P:System.Threading.ThreadLocal`1.Value" /> is initialized on the current thread; otherwise false.</returns>
</member>
<member name="P:System.Threading.ThreadLocal`1.Value">
<summary>Gets or sets the value of this instance for the current thread.</summary>
+ <returns>Returns an instance of the object that this ThreadLocal is responsible for initializing.</returns>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.ThreadLocal`1" /> instance has been disposed.</exception>
<exception cref="T:System.InvalidOperationException">The initialization function attempted to reference <see cref="P:System.Threading.ThreadLocal`1.Value" /> recursively.</exception>
<exception cref="T:System.MissingMemberException">No parameterless constructor is provided and no value factory is supplied.</exception>
- <returns>Returns an instance of the object that this ThreadLocal is responsible for initializing.</returns>
</member>
<member name="P:System.Threading.ThreadLocal`1.Values">
- <summary>Gets a list containing the values stored by all threads that have accessed this instance.</summary>
+ <summary>Gets a list for all of the values currently stored by all of the threads that have accessed this instance.</summary>
+ <returns>A list for all of the values currently stored by all of the threads that have accessed this instance.</returns>
<exception cref="T:System.InvalidOperationException">Values stored by all threads are not available because this instance was initialized with the <paramref name="trackAllValues" /> argument set to <see langword="false" /> in the call to a class constructor.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.ThreadLocal`1" /> instance has been disposed.</exception>
- <returns>A list for all of the values stored by all of the threads that have accessed this instance.</returns>
</member>
<member name="T:System.Threading.Volatile">
<summary>Contains methods for performing volatile memory operations.</summary>
<member name="M:System.Threading.Volatile.Read(System.Boolean@)">
<summary>Reads the value of the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears after this method in the code, the processor cannot move it before this method.</summary>
<param name="location">The field to read.</param>
- <returns>The value that was read.</returns>
+ <returns>The value that was read. This value is the latest written by any processor in the computer, regardless of the number of processors or the state of processor cache.</returns>
</member>
<member name="M:System.Threading.Volatile.Read(System.Byte@)">
<summary>Reads the value of the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears after this method in the code, the processor cannot move it before this method.</summary>
<param name="location">The field to read.</param>
- <returns>The value that was read.</returns>
+ <returns>The value that was read. This value is the latest written by any processor in the computer, regardless of the number of processors or the state of processor cache.</returns>
</member>
<member name="M:System.Threading.Volatile.Read(System.Double@)">
<summary>Reads the value of the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears after this method in the code, the processor cannot move it before this method.</summary>
<param name="location">The field to read.</param>
- <returns>The value that was read.</returns>
+ <returns>The value that was read. This value is the latest written by any processor in the computer, regardless of the number of processors or the state of processor cache.</returns>
</member>
<member name="M:System.Threading.Volatile.Read(System.Int16@)">
<summary>Reads the value of the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears after this method in the code, the processor cannot move it before this method.</summary>
<param name="location">The field to read.</param>
- <returns>The value that was read.</returns>
+ <returns>The value that was read. This value is the latest written by any processor in the computer, regardless of the number of processors or the state of processor cache.</returns>
</member>
<member name="M:System.Threading.Volatile.Read(System.Int32@)">
<summary>Reads the value of the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears after this method in the code, the processor cannot move it before this method.</summary>
<param name="location">The field to read.</param>
- <returns>The value that was read.</returns>
+ <returns>The value that was read. This value is the latest written by any processor in the computer, regardless of the number of processors or the state of processor cache.</returns>
</member>
<member name="M:System.Threading.Volatile.Read(System.Int64@)">
<summary>Reads the value of the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears after this method in the code, the processor cannot move it before this method.</summary>
<param name="location">The field to read.</param>
- <returns>The value that was read.</returns>
+ <returns>The value that was read. This value is the latest written by any processor in the computer, regardless of the number of processors or the state of processor cache.</returns>
</member>
<member name="M:System.Threading.Volatile.Read(System.IntPtr@)">
<summary>Reads the value of the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears after this method in the code, the processor cannot move it before this method.</summary>
<param name="location">The field to read.</param>
- <returns>The value that was read.</returns>
+ <returns>The value that was read. This value is the latest written by any processor in the computer, regardless of the number of processors or the state of processor cache.</returns>
</member>
<member name="M:System.Threading.Volatile.Read(System.SByte@)">
<summary>Reads the value of the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears after this method in the code, the processor cannot move it before this method.</summary>
<param name="location">The field to read.</param>
- <returns>The value that was read.</returns>
+ <returns>The value that was read. This value is the latest written by any processor in the computer, regardless of the number of processors or the state of processor cache.</returns>
</member>
<member name="M:System.Threading.Volatile.Read(System.Single@)">
<summary>Reads the value of the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears after this method in the code, the processor cannot move it before this method.</summary>
<param name="location">The field to read.</param>
- <returns>The value that was read.</returns>
+ <returns>The value that was read. This value is the latest written by any processor in the computer, regardless of the number of processors or the state of processor cache.</returns>
</member>
<member name="M:System.Threading.Volatile.Read(System.UInt16@)">
<summary>Reads the value of the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears after this method in the code, the processor cannot move it before this method.</summary>
<param name="location">The field to read.</param>
- <returns>The value that was read.</returns>
+ <returns>The value that was read. This value is the latest written by any processor in the computer, regardless of the number of processors or the state of processor cache.</returns>
</member>
<member name="M:System.Threading.Volatile.Read(System.UInt32@)">
<summary>Reads the value of the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears after this method in the code, the processor cannot move it before this method.</summary>
<param name="location">The field to read.</param>
- <returns>The value that was read.</returns>
+ <returns>The value that was read. This value is the latest written by any processor in the computer, regardless of the number of processors or the state of processor cache.</returns>
</member>
<member name="M:System.Threading.Volatile.Read(System.UInt64@)">
<summary>Reads the value of the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears after this method in the code, the processor cannot move it before this method.</summary>
<param name="location">The field to read.</param>
- <returns>The value that was read.</returns>
+ <returns>The value that was read. This value is the latest written by any processor in the computer, regardless of the number of processors or the state of processor cache.</returns>
</member>
<member name="M:System.Threading.Volatile.Read(System.UIntPtr@)">
<summary>Reads the value of the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears after this method in the code, the processor cannot move it before this method.</summary>
<param name="location">The field to read.</param>
- <returns>The value that was read.</returns>
+ <returns>The value that was read. This value is the latest written by any processor in the computer, regardless of the number of processors or the state of processor cache.</returns>
</member>
<member name="M:System.Threading.Volatile.Read``1(``0@)">
<summary>Reads the object reference from the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears after this method in the code, the processor cannot move it before this method.</summary>
<member name="M:System.Threading.Volatile.Write(System.Boolean@,System.Boolean)">
<summary>Writes the specified value to the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears before this method in the code, the processor cannot move it after this method.</summary>
<param name="location">The field where the value is written.</param>
- <param name="value">The value to write.</param>
+ <param name="value">The value to write. The value is written immediately so that it is visible to all processors in the computer.</param>
</member>
<member name="M:System.Threading.Volatile.Write(System.Byte@,System.Byte)">
<summary>Writes the specified value to the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears before this method in the code, the processor cannot move it after this method.</summary>
<param name="location">The field where the value is written.</param>
- <param name="value">The value to write.</param>
+ <param name="value">The value to write. The value is written immediately so that it is visible to all processors in the computer.</param>
</member>
<member name="M:System.Threading.Volatile.Write(System.Double@,System.Double)">
<summary>Writes the specified value to the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears before this method in the code, the processor cannot move it after this method.</summary>
<param name="location">The field where the value is written.</param>
- <param name="value">The value to write.</param>
+ <param name="value">The value to write. The value is written immediately so that it is visible to all processors in the computer.</param>
</member>
<member name="M:System.Threading.Volatile.Write(System.Int16@,System.Int16)">
<summary>Writes the specified value to the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears before this method in the code, the processor cannot move it after this method.</summary>
<param name="location">The field where the value is written.</param>
- <param name="value">The value to write.</param>
+ <param name="value">The value to write. The value is written immediately so that it is visible to all processors in the computer.</param>
</member>
<member name="M:System.Threading.Volatile.Write(System.Int32@,System.Int32)">
<summary>Writes the specified value to the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears before this method in the code, the processor cannot move it after this method.</summary>
<param name="location">The field where the value is written.</param>
- <param name="value">The value to write.</param>
+ <param name="value">The value to write. The value is written immediately so that it is visible to all processors in the computer.</param>
</member>
<member name="M:System.Threading.Volatile.Write(System.Int64@,System.Int64)">
<summary>Writes the specified value to the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears before this method in the code, the processor cannot move it after this method.</summary>
<param name="location">The field where the value is written.</param>
- <param name="value">The value to write.</param>
+ <param name="value">The value to write. The value is written immediately so that it is visible to all processors in the computer.</param>
</member>
<member name="M:System.Threading.Volatile.Write(System.IntPtr@,System.IntPtr)">
<summary>Writes the specified value to the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears before this method in the code, the processor cannot move it after this method.</summary>
<param name="location">The field where the value is written.</param>
- <param name="value">The value to write.</param>
+ <param name="value">The value to write. The value is written immediately so that it is visible to all processors in the computer.</param>
</member>
<member name="M:System.Threading.Volatile.Write(System.SByte@,System.SByte)">
<summary>Writes the specified value to the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears before this method in the code, the processor cannot move it after this method.</summary>
<param name="location">The field where the value is written.</param>
- <param name="value">The value to write.</param>
+ <param name="value">The value to write. The value is written immediately so that it is visible to all processors in the computer.</param>
</member>
<member name="M:System.Threading.Volatile.Write(System.Single@,System.Single)">
<summary>Writes the specified value to the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears before this method in the code, the processor cannot move it after this method.</summary>
<param name="location">The field where the value is written.</param>
- <param name="value">The value to write.</param>
+ <param name="value">The value to write. The value is written immediately so that it is visible to all processors in the computer.</param>
</member>
<member name="M:System.Threading.Volatile.Write(System.UInt16@,System.UInt16)">
<summary>Writes the specified value to the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears before this method in the code, the processor cannot move it after this method.</summary>
<param name="location">The field where the value is written.</param>
- <param name="value">The value to write.</param>
+ <param name="value">The value to write. The value is written immediately so that it is visible to all processors in the computer.</param>
</member>
<member name="M:System.Threading.Volatile.Write(System.UInt32@,System.UInt32)">
<summary>Writes the specified value to the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears before this method in the code, the processor cannot move it after this method.</summary>
<param name="location">The field where the value is written.</param>
- <param name="value">The value to write.</param>
+ <param name="value">The value to write. The value is written immediately so that it is visible to all processors in the computer.</param>
</member>
<member name="M:System.Threading.Volatile.Write(System.UInt64@,System.UInt64)">
<summary>Writes the specified value to the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears before this method in the code, the processor cannot move it after this method.</summary>
<param name="location">The field where the value is written.</param>
- <param name="value">The value to write.</param>
+ <param name="value">The value to write. The value is written immediately so that it is visible to all processors in the computer.</param>
</member>
<member name="M:System.Threading.Volatile.Write(System.UIntPtr@,System.UIntPtr)">
<summary>Writes the specified value to the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears before this method in the code, the processor cannot move it after this method.</summary>
<param name="location">The field where the value is written.</param>
- <param name="value">The value to write.</param>
+ <param name="value">The value to write. The value is written immediately so that it is visible to all processors in the computer.</param>
</member>
<member name="M:System.Threading.Volatile.Write``1(``0@,``0)">
<summary>Writes the specified object reference to the specified field. On systems that require it, inserts a memory barrier that prevents the processor from reordering memory operations as follows: If a read or write appears before this method in the code, the processor cannot move it after this method.</summary>
<param name="location">The field where the object reference is written.</param>
- <param name="value">The object reference to write.</param>
+ <param name="value">The object reference to write. The reference is written immediately so that it is visible to all processors in the computer.</param>
<typeparam name="T">The type of field to write. This must be a reference type, not a value type.</typeparam>
</member>
<member name="T:System.Threading.WaitHandleCannotBeOpenedException">
projects / platform / core / csapi / tizenfx.git / blobdiff