AXIAM PHP SDK

SsfPollResult
in package

FinalYes

What {@see SsfReceiver::poll()} returns: the verified SETs and the refused ones, apart — and the ones it could not judge.

A SET is unjudged when a failure that is not a verdict on it — a JWKS or configuration fetch that fails, a replay store that cannot answer — stopped poll() before it reached a verdict (CONTRACT.md §32.7, §34.2 P1 and P3). An unjudged SET is in neither events nor refused, its jti was not recorded, and you neither acknowledge it nor report it in setErrs: the transmitter offers it again, and a later poll judges it.

Table of Contents

Properties

$events  : array<string|int, mixed>
$moreAvailable  : bool
$refused  : array<string|int, mixed>
$unjudged  : array<string|int, mixed>
$unjudgedCause  : Throwable|null

Methods

__construct()  : mixed

Properties

$unjudged read-only

public array<string|int, mixed> $unjudged = []

$unjudgedCause read-only

public Throwable|null $unjudgedCause = null

Methods

__construct()

public __construct(array<int, SecurityEvent> $events, bool $moreAvailable, array<int, RefusedSet> $refused[, array<int, string> $unjudged = [] ][, Throwable|null $unjudgedCause = null ]) : mixed
Parameters
$events : array<int, SecurityEvent>

The SETs that verified, in the transmitter's order. Every jti the replay store recorded is here.

$moreAvailable : bool

Whether the transmitter holds more.

$refused : array<int, RefusedSet>

The SETs that did not verify.

$unjudged : array<int, string> = []

The jtis (the poll map keys) of the SETs that were not judged, in the transmitter's order; empty when every SET was.

$unjudgedCause : Throwable|null = null

The failure that left them unjudged — a NetworkError for a key fetch or a replay store that could not answer (the store's exception chained as its cause; an SDK error the store raised, unchanged) — null when $unjudged is empty.

On this page

Search results