Documentation

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

setDelaySec()

public setDelaySec(int $delay) : $this
Parameters
$delay : int

Delay between successive attempts to poll a queue.

Tags
throws
MindeeApiException

Throws if the delay is too low.

Return values
$this

setInitialDelaySec()

public setInitialDelaySec(int $initialDelay) : $this
Parameters
$initialDelay : int

Delay between polls.

Tags
throws
MindeeApiException

Throws if the initial parsing delay is less than 4 seconds.

Return values
$this

setMaxRetries()

public setMaxRetries(int $maxRetries) : $this
Parameters
$maxRetries : int

Maximum allowed retries. Will default to 80 if an invalid number is provided.

Return values
$this

        
On this page

Search results