WorkflowTimeoutCleanupRequested
extends WorkflowCancelled
in package
FinalYes
Delivered to workflow code when its work deadline passes and the run opted in to deadline-triggered timeout cleanup (workflow#863). It is a cooperative cancellation request, so existing `catch (WorkflowCancelled)` handlers (saga compensation) run; the run still ends timed out. Its context's `cause` is `timeout`.
Tags
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 = 'Workflow work deadline passed: timeout cleanup requested.' ][, int $code = 0 ][, Throwable|null $previous = null ][, string|null $requestId = null ][, CancellationContext|ScopedCancellationContext|null $context = null ]) : mixed
Parameters
- $message : string = 'Workflow work deadline passed: timeout cleanup requested.'
- $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