WorkflowCancelled
extends DurableWorkflowException
in package
A cooperative cancellation request delivered at an authored call, or a workflow result that closed cancelled.
Timeout cleanup delivers the WorkflowTimeoutCleanupRequested subtype, so handlers that catch this class also run on timeout cleanup.
Table of Contents
Properties
- $context : CancellationContext|ScopedCancellationContext|null
- $requestId : string|null
Methods
- __construct() : mixed
- forContext() : self
- The exception for a delivered request: the timeout cleanup subtype when its context's `cause` is `timeout`.
Properties
$context read-only
public
CancellationContext|ScopedCancellationContext|null
$context
= null
$requestId read-only
public
string|null
$requestId
= null
Methods
__construct()
public
__construct([string $message = '' ][, int $code = 0 ][, Throwable|null $previous = null ][, string|null $requestId = null ][, CancellationContext|ScopedCancellationContext|null $context = null ]) : mixed
Parameters
- $message : string = ''
- $code : int = 0
- $previous : Throwable|null = null
- $requestId : string|null = null
- $context : CancellationContext|ScopedCancellationContext|null = null
forContext()
The exception for a delivered request: the timeout cleanup subtype when its context's `cause` is `timeout`.
public
static forContext(string|null $requestId, CancellationContext|ScopedCancellationContext|null $context[, string|null $message = null ]) : self
Parameters
- $requestId : string|null
- $context : CancellationContext|ScopedCancellationContext|null
- $message : string|null = null