PollingOptions
in package
Handles options tied to asynchronous parsing.
Table of Contents
Properties
- $delaySec : float
- $initialDelaySec : float
- $maxRetries : int
Methods
- __construct() : mixed
- Polling Options.
- setDelaySec() : $this
- setInitialDelaySec() : $this
- setMaxRetries() : $this
Properties
$delaySec
public
float
$delaySec
Delay (in seconds) between successive attempts to poll a queue.
$initialDelaySec
public
float
$initialDelaySec
Initial delay (in seconds) before attempting to poll a queue.
$maxRetries
public
int
$maxRetries
Maximum number of retries for a queue.
Methods
__construct()
Polling Options.
public
__construct([float $initialDelaySec = 2.0 ][, float $delaySec = 1.5 ][, int $maxRetries = 80 ]) : mixed
Parameters
- $initialDelaySec : float = 2.0
-
Initial delay (in seconds) before attempting to poll a queue.
- $delaySec : float = 1.5
-
Delay (in seconds) between successive attempts to poll a queue.
- $maxRetries : int = 80
-
Maximum number of retries for a queue.
Tags
setDelaySec()
public
setDelaySec(float $delay) : $this
Parameters
- $delay : float
-
Delay between successive attempts to poll a queue.
Tags
Return values
$thissetInitialDelaySec()
public
setInitialDelaySec(float $initialDelay) : $this
Parameters
- $initialDelay : float
-
Delay between polls.
Tags
Return values
$thissetMaxRetries()
public
setMaxRetries(int $maxRetries) : $this
Parameters
- $maxRetries : int
-
Maximum allowed retries. Will default to 80 if an invalid number is provided.