Circuit.RequestCircuitPauseAsync(CancellationToken) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Requests that the connected client begin the graceful circuit-pause flow.
public System.Threading.Tasks.ValueTask<bool> RequestCircuitPauseAsync(System.Threading.CancellationToken cancellationToken = default);member this.RequestCircuitPauseAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<bool>Public Function RequestCircuitPauseAsync (Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Boolean)Parameters
- cancellationToken
- CancellationToken
Cancels the request before it is accepted by the framework.
Returns
true if the request was accepted and the client was asked to begin pausing;
otherwise false.
Remarks
The operation is idempotent. Observe completion through OnConnectionDownAsync(Circuit, CancellationToken) and OnCircuitClosedAsync(Circuit, CancellationToken).