Documentation

DeferredFuture
in package
uses ForbidCloning, ForbidSerialization

FinalYes
Tags
template

Table of Contents

Properties

$future  : Future<string|int, T>
$state  : FutureState<string|int, T>

Methods

__construct()  : mixed
__serialize()  : never
__unserialize()  : never
complete()  : void
Completes the operation with a result value.
error()  : void
Marks the operation as failed.
getFuture()  : Future<string|int, T>
isComplete()  : bool
__clone()  : mixed

Properties

Methods

__unserialize()

public final __unserialize(array<string|int, mixed> $data) : never
Parameters
$data : array<string|int, mixed>
Return values
never

complete()

Completes the operation with a result value.

public complete([T $value = null ]) : void
Parameters
$value : T = null

Result of the operation.

error()

Marks the operation as failed.

public error(Throwable $throwable) : void
Parameters
$throwable : Throwable

Throwable to indicate the error.

getFuture()

public getFuture() : Future<string|int, T>
Return values
Future<string|int, T>

The future associated with this Deferred.

isComplete()

public isComplete() : bool
Return values
bool

True if the operation has completed.


        
On this page

Search results