bayou.async

Interface AutoAsync<T>

All Superinterfaces:

Async<T>

All Known Implementing Classes:

HttpResponseImpl, WebSocketResponse.Accept, WebSocketResponse.Reject

public interface AutoAsync<T>
extends Async<T>

To make a type also as an `Async` type.

Often we need to convert a `Foo` object to an `Async<Foo>` object. This can be done by `Async.success(foo)`; but it can become tedious if it happens a lot.

By simply `extends/implements AutoAsync<Foo>`, we can make an `interface/class Bar` a subtype of `Async<Foo>`, then a `Bar` object can be used anywhere an `Async<Foo>` is needed. Note that `AutoAsync` is an interface with no abstract method.

Requirement: if `interface/class Bar extends/implements AutoAsync<Foo>`, it must be true that `Bar` is `Foo` or a subtype of `Foo`.

Caution: Bar inherits all instance methods from Async<Foo>, which can create confusions along with Bar's own methods.

One usage example is `HttpResponseImpl`:

     public class HttpResponseImpl implements HttpResponse, AutoAsync<HttpResponse>
 

this means that an HttpResponseImpl object can be used any where an Async<HttpResponse> is needed.

Method Summary

Default Methods
Result<T>	pollResult() Implements Async.pollResult().
boolean	isCompleted() return `true`
void	onCompletion(Consumer<Result<T>> callback) Implements Async.onCompletion(Consumer).
void	cancel(Exception reason) Implements Async.cancel(Exception); by default, do nothing.
Async<T>	timeout(Duration duration) Implements Async.timeout(Duration); by default, do nothing.

Methods inherited from interface bayou.async.Async

catch__, catch_, covary, finally_, finally_, map, map, peek, peek, sync, then, then, transform

Method Detail

pollResult

default Result<T> pollResult()

Implements Async.pollResult(). Equivalent to `Result.success( (T)this) )`

Specified by:

pollResult in interface Async<T>

isCompleted

default boolean isCompleted()

return `true`

Specified by:

isCompleted in interface Async<T>

onCompletion

default void onCompletion(Consumer<Result<T>> callback)

Implements Async.onCompletion(Consumer). Note that `this` is already completed.

Specified by:

onCompletion in interface Async<T>

cancel

default void cancel(Exception reason)

Implements Async.cancel(Exception); by default, do nothing.

Specified by:

cancel in interface Async<T>

timeout

default Async<T> timeout(Duration duration)

Implements Async.timeout(Duration); by default, do nothing. Returns `this`.

Specified by:

timeout in interface Async<T>

Returns:

`this`