SsfPollOptions
in package
FinalYes
Arguments to {@see SsfReceiver::poll()} (RFC 8936). Every member is passed through exactly as given; an unset (`null`) one is not sent, so a poll with no options sends `{}`.
Table of Contents
Properties
- $ack : array<string|int, mixed>|null
- $maxEvents : int|null
- $returnImmediately : bool|null
- $setErrs : array<string|int, mixed>|null
Methods
- __construct() : mixed
- toArray() : array<string, mixed>
- The JSON object `poll()` sends: only the members set.
Properties
$ack read-only
public
array<string|int, mixed>|null
$ack
= null
$maxEvents read-only
public
int|null
$maxEvents
= null
$returnImmediately read-only
public
bool|null
$returnImmediately
= null
$setErrs read-only
public
array<string|int, mixed>|null
$setErrs
= null
Methods
__construct()
public
__construct([int|null $maxEvents = null ][, bool|null $returnImmediately = null ][, array<int, string>|null $ack = null ][, array<string, SetErr>|null $setErrs = null ]) : mixed
Parameters
- $maxEvents : int|null = null
-
maxEvents— the server clamps it to 100;0acknowledges and returns nothing. - $returnImmediately : bool|null = null
-
returnImmediately— without it the server long-polls up to 30 s. - $ack : array<int, string>|null = null
-
ack— thejtis you processed since the last poll. - $setErrs : array<string, SetErr>|null = null
-
setErrs— thejtis you refuse, each with its code.
toArray()
The JSON object `poll()` sends: only the members set.
public
toArray() : array<string, mixed>