Application
Table of Contents
Interfaces
- Authentication
- Supplies request headers without coupling the SDK to an auth provider.
- LaravelWorkflowClientInterface
- Laravel-native workflow starts and handles resolved from attributed service classes.
- PayloadCodec
- MetricsRecorder
- Application-owned sink for process observations, with no exporter dependency.
- BoundedPayloadTransport
- Optional payload download capability with a complete request time bound.
- BoundedPayloadUploadTransport
- Optional payload upload capability that bounds transmission and response reads.
- BoundedProgressPayloadTransport
- Optional finite payload streaming with supervision during transfer and idle I/O.
- BoundedTransport
- A transport that can bound the complete request, including connection and body reads.
- PayloadTransport
- Optional binary capability; existing JSON-only custom transports remain valid.
- PayloadUploadTransport
- Optional upload capability; download-only custom transports remain compatible.
- ProgressPayloadTransport
- Optional progress checkpoints for an ordinary streamed payload download.
- RequestSizeLimitTransport
- Optional knowledge of a lower encoded request-body limit.
- ResponseStatusTransport
- Optional status metadata; existing custom transports remain supported.
- Transport
- WorkflowClientInterface
- The application-facing workflow operations implemented by Client and its test fake.
- WorkflowHandleInterface
- Workflow interactions shared by live and in-memory handles.
Classes
- Activity
- Marks a public method as an activity handler.
- Query
- Marks a public workflow method as a query handler.
- Signal
- Marks a workflow method whose signature declares an accepted signal contract.
- Update
- Marks a public workflow method as an update handler.
- Workflow
- Marks the public entry method of a class-oriented workflow.
- StaticHeadersAuthentication
- Authentication adapter for API keys, signed headers, and gateway identities.
- TokenAuthentication
- Bearer authentication with optional independent control and worker tokens.
- WorkerDiagnosticEvent
- A worker lifecycle, retry, shutdown, or handler diagnostic.
- FrameworkRuntimeException
- Actionable console-facing error for a framework-managed worker.
- DurableWorkflowServiceProvider
- Auto-discovered Laravel registration for the optional service-mode bridge.
- DurableWorkflow
- Laravel facade for application workflow interactions and test fakes.
- LaravelWorkflowClient
- Resolves configured Laravel workflow services to their public protocol types.
- LogContext
- Laravel logging tap; configure once on each application channel that needs correlation.
- ProcessCredentialResolver
- Resolves role credentials only when a Laravel client is constructed.
- LaravelWorkflowClientFake
- Laravel-native fake for class-shaped workflow starts and handles.
- WorkerCommand
- Runs a supervised service-mode worker from Artisan.
- WorkerFactory
- Builds workers whose attributed handlers come from Laravel's container.
- WorkflowStartOptions
- Optional service-mode start fields beyond the Laravel bridge defaults.
- ServiceConfiguration
- Validated service-mode settings shared by the optional framework bridges.
- Configuration
- Symfony configuration schema for Server and Cloud service-mode connections.
- DurableWorkflowExtension
- Registers validated, autowired Symfony services without owning durable state.
- WorkflowLifetimePass
- Keeps workflow services fresh while leaving injected collaborators under container ownership.
- DurableWorkflowBundle
- Optional Symfony Bundle for Durable Workflow service mode.
- WorkerCommand
- Runs a supervised service-mode worker from Symfony Console.
- WorkerFactory
- Builds workers from Symfony's tagged, autowired handler services.
- Client
- Synchronous control-plane and worker-plane client for the standalone server.
- AvroBinaryValue
- Explicit binary adapter for PHP strings intended for Avro `bytes`.
- AvroMapValue
- Explicit adapter for Avro maps that PHP arrays cannot represent faithfully.
- AvroPayloadCodec
- Fixed durable_workflow.protocol.Value codec using Avro single-object encoding.
- ValueDatumDecoder
- Enforces the fixed Value policy where Apache Avro PHP decodes permissively.
- ValueDatumReader
- Apache PHP adapter for warning-free recursive named-union resolution.
- ValueDatumWriter
- Selects fixed Value branches without collapsing PHP map keys.
- ActivityCancelled
- ActivityFailed
- ChildWorkflowFailed
- CodecException
- DurableOperationCancelled
- DurableWorkflowException
- ExternalPayloadException
- Runtime payload transport/integrity failure, identified by the stable reason field.
- FailureReportRefused
- A local reporting refusal, separate from the application's original failure.
- InvalidLocalActivityReport
- A local activity produced a report that cannot fit the bounded wire contract.
- InvalidWorkerDefinition
- A handler class or method cannot form a valid worker contract.
- LocalActivityTimedOut
- Cooperative local-activity timeout observed at an execution boundary.
- NonDeterministicWorkflow
- PaginationException
- A malformed page cannot safely continue an enumeration.
- QueryFailed
- ReplayClockUnavailable
- The current invocation has no authoritative consumed business-clock boundary.
- SagaCompensationFailed
- A saga forward failure was followed by a terminal compensation activity failure.
- ScheduleAlreadyExists
- The Server refused to create a schedule because its id is taken (409 schedule_already_exists).
- ServerCapabilityUnavailable
- The connected Server has no route for an additive capability the call needs.
- ServerException
- ServiceOperationFailed
- A recorded service failure or cancellation thrown at the original call.
- SignalFailed
- A signal the Server refused, or whose request did not complete.
- TransportException
- UpdateFailed
- An update the Server refused, or whose request did not complete.
- UpdateStillPending
- An update the Server accepted that had not completed when the wait ended.
- WorkflowCancelled
- A cooperative cancellation request delivered at an authored call, or a workflow result that closed cancelled.
- WorkflowEntryArgumentsMismatch
- Entry input cannot bind, before application workflow code starts.
- WorkflowFailed
- WorkflowTaskCompletionTooLarge
- The Server refused a workflow-task completion because the whole request is over its completion size limit (413 `payload_too_large`, `limit_kind: workflow_task_completion_bytes`, Server 3.6.0).
- WorkflowTerminated
- WorkflowTimedOut
- WorkflowTimeoutCleanupRequested
- 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`.
- FailureReportLimits
- SDK failure-report budgets; these do not change the Server's request limit.
- InMemoryMetricsRecorder
- Keeps observations in process memory, for tests and diagnostics.
- NoopMetricsRecorder
- Default recorder; the application opts into exporting observations.
- OpenTelemetryMetricsRecorder
- Forwards SDK observations to the application's OpenTelemetry meter provider.
- ClusterInfo
- Public compatibility and capability manifest returned by cluster discovery.
- NamespaceDescription
- ScheduleAction
- Workflow-start action run by a schedule.
- ScheduleDescription
- ScheduleOrigin
- The schedule fire that started a run, read from the run's own ScheduleTriggered history event.
- SchedulePage
- One namespace-scoped page from the schedule list API.
- ScheduleSpec
- Portable cron and fixed-interval schedule specification.
- SearchAttributeCollection
- Search attribute definitions available in one namespace.
- SearchAttributeDefinition
- Result of creating or deleting a custom search attribute.
- ServiceOperationDescription
- Current server view of a durable service operation call.
- ServiceOperationOptions
- Immutable routing and waiting options for a service operation.
- ServiceOperationResult
- The immutable outcome delivered at a workflow's service-operation boundary.
- WorkflowExecution
- WorkflowPage
- One page from the workflow visibility API.
- WorkflowRun
- WorkflowStreamAppendItem
- One typed item supplied to a Workflow Streams append operation.
- WorkflowStreamAppendResult
- Durable acceptance outcome for one Workflow Stream append batch.
- WorkflowStreamDescription
- Lifecycle and backlog metadata for one run-scoped Workflow Stream.
- WorkflowStreamItem
- One offset-addressed item read from a Workflow Stream.
- WorkflowStreamPage
- One bounded, resumable long-poll response from a Workflow Stream.
- ScheduleHandle
- Operations bound to a schedule ID.
- SdkIdentity
- Resolves the SDK package identity from Composer's installed-package metadata.
- ServiceOperationHandle
- Operations bound to one durable service call.
- ExecutionTelemetry
- Optional execution instrumentation using application-owned OpenTelemetry providers.
- LogContext
- Optional Monolog 2/3 processor. Attach once to the application's logger.
- TraceCarrier
- Optional observations. A validated carrier never grants a receipt or lease.
- TraceLinks
- Bounded secondary observations from an already authorized original claim.
- AssertionFailed
- A framework-independent Durable Workflow test assertion failed.
- TestWorkflowHandle
- In-memory workflow handle returned by WorkflowClientFake.
- WorkerTestHarness
- Executes and asserts registered worker handlers without polling a server.
- WorkflowClientFake
- Records workflow client interactions and supplies configured test results.
- PollTransport
- The negotiated envelope carries HTTP outcomes after response progress starts.
- Psr18Transport
- Default PSR-18 JSON and bounded runtime-payload transport.
- RuntimePayloads
- Resolve only protocol envelope fields, never arbitrary application projections.
- RuntimePayloadUploads
- Namespace-scoped discovery and request-local, content-addressed uploads.
- Version
- Protocol versions advertised to the standalone server.
- ActivityContext
- Activity attempt metadata and heartbeat/cancellation support.
- ActivityLeaseMaintenanceException
- The independent activity maintenance process cannot start or communicate.
- ActivityRetryInfo
- Immutable attempt identity and retry snapshot received with an activity claim.
- CancelDurableOperationCommand
- CancellationContext
- Immutable root request and cleanup budget read from canonical history.
- CancellationDelivery
- The durable authored call at which the Server committed cancellation delivery.
- CancellationHistory
- Observations identify a request. Only canonical history can authorize its delivery.
- CancellationRequest
- Server-owned request identity, deadline and opaque history refresh location.
- CapabilityManifest
- Truthful feature-by-feature manifest sent with every managed worker registration.
- ChildWorkflowHandle
- A child workflow whose start the runtime has committed.
- ChildWorkflowIdentity
- The committed identity of a child started with WorkflowContext::startChildWorkflow().
- DeferredWorkflowOperation
- One durable operation prepared for a {@see WorkflowContext::all()} barrier.
- DurableOperationHandle
- HandlerResolver
- Resolves class-oriented handlers through PSR-11 or a no-container default.
- MessageStream
- Replay-safe receiver for repeated, ordered workflow input.
- MessageStreamMessage
- One server-ordered message consumed from a durable named stream.
- PollResponse
- Classifies full worker poll response envelopes using protocol fields.
- QueryContext
- Immutable committed state supplied to query and update handlers.
- Replayer
- Re-executes a straight-line workflow Fiber against committed, sequence-ordered history.
- ReplayResult
- Saga
- Registers activity compensations and replays them in deterministic reverse order.
- ScopedCancellationContext
- Immutable original scope ancestry carried by a candidate cooperative child request.
- SelectionResult
- StickyWorkflowCache
- Bounded process-local cache keyed by exact workflow/run/build identity.
- WorkerSession
- Typed create/use/renew/close handle for one worker-held session lease.
- WorkerSessionOptions
- Typed worker-session routing and lease options for activity commands.
- WorkflowCommand
- A replayable command emitted when straight-line workflow code suspends.
- WorkflowContext
- Straight-line deterministic operations available while a workflow Fiber is replayed.
- WorkflowFactory
- Creates an attributed workflow instance while retaining application-owned dependencies.
- Worker
- Managed synchronous remote worker for workflow, activity, query, and update tasks.
- WorkflowHandle
- Operations bound to one stable workflow ID and, optionally, its originally selected run.
Traits
- InteractsWithDurableWorkflow
- Replaces the autowired workflow client in a Symfony KernelTestCase container.
- CarriesCommandRequestId
- The caller command key and Server refusal carried by signal and update failures.
Enums
- CancellationPolicy
- What an awaiting workflow does when cancellation reaches its operation.
- ParentClosePolicy
- What happens to an open child after its parent closes.