API Documentation
Back to top  

Async

An asynchronous exit point for a test.<p/>

package

Default

Methods

__construct

__construct()

Cause the current thread to wait until this completion completes.<p/>

await( $arg0 = null) : void

If the current thread is interrupted, an exception will be thrown.

await()

Cause the current thread to wait until this completion completes with a configurable timeout.

If completion times out or the current thread is interrupted, an exception will be thrown.

param $timeoutMillis [integer] the timeout in milliseconds await($timeoutMillis)

Arguments

$arg0

integer

Cause the current thread to wait until this completion completes and succeeds.<p/>

awaitSuccess( $arg0 = null) : void

If the current thread is interrupted or the suite fails, an exception will be thrown.

awaitSuccess()

Cause the current thread to wait until this completion completes and succeeds with a configurable timeout.

If completion times out or the current thread is interrupted or the suite fails, an exception will be thrown.

param $timeoutMillis [integer] the timeout in milliseconds awaitSuccess($timeoutMillis)

Arguments

$arg0

integer

Signals the asynchronous operation is done, this method must be called with a count greater than <code>0</code>, otherwise it throws an <code>IllegalStateException</code> to signal the error.

complete() : void

count

count() : integer

Response

integer

the current count

Count down the async.

countDown() : void

Completion handler to receive a completion signal when this completions completes.

handler( $arg0) : void

Arguments

$arg0

callable

isCompleted

isCompleted() : boolean

Response

boolean

true if this completion is completed

isFailed

isFailed() : boolean

Response

boolean

true if the this completion is completed and failed

isSucceeded

isSucceeded() : boolean

Response

boolean

true if this completion is completed and succeeded

Completes the future upon completion, otherwise fails it.

resolve( $arg0) : void

Arguments

$arg0

Future