Durable Workflow PHP SDK — API Reference

Guides

WorkerSession
in package

FinalYes

Typed create/use/renew/close handle for one worker-held session lease.

Table of Contents

Properties

$options  : WorkerSessionOptions
$workerId  : string
$client  : Client
$closed  : bool
$closeResponse  : array<string, mixed>|null

Methods

__construct()  : mixed
activityOptions()  : array<string, mixed>
close()  : array<string, mixed>
create()  : array<string, mixed>
rebuildRequiredAfterHolderLoss()  : bool
renew()  : array<string, mixed>

Properties

$closeResponse

private array<string, mixed>|null $closeResponse = null

Methods

activityOptions()

public activityOptions() : array<string, mixed>
Return values
array<string, mixed>

close()

public close([string $reason = 'worker_shutdown' ]) : array<string, mixed>
Parameters
$reason : string = 'worker_shutdown'
Return values
array<string, mixed>

create()

public create() : array<string, mixed>
Return values
array<string, mixed>

rebuildRequiredAfterHolderLoss()

public rebuildRequiredAfterHolderLoss() : bool
Return values
bool

renew()

public renew([int|null $leaseSeconds = null ]) : array<string, mixed>
Parameters
$leaseSeconds : int|null = null
Return values
array<string, mixed>
On this page

Search results