org.asynchttpclient.extras.rxjava2

Interface RxHttpClient

All Known Implementing Classes:

DefaultRxHttpClient

public interface RxHttpClient

Prepares HTTP requests by wrapping them into RxJava 2 Maybe instances.

See Also:

RxJava – Reactive Extensions for the JVM

Method Summary

Modifier and Type	Method and Description
static RxHttpClient	create(AsyncHttpClient asyncHttpClient) Returns a new RxHttpClient instance that uses the given asyncHttpClient under the hoods.
default io.reactivex.Maybe<Response>	prepare(Request request) Prepares the given request.
<T> io.reactivex.Maybe<T>	prepare(Request request, java.util.function.Supplier<? extends AsyncHandler<T>> handlerSupplier) Prepares the given request.

Method Detail

create

static RxHttpClient create(AsyncHttpClient asyncHttpClient)

Returns a new RxHttpClient instance that uses the given asyncHttpClient under the hoods.

Parameters:

asyncHttpClient - the Async HTTP Client instance to be used

Returns:

a new RxHttpClient instance

Throws:

NullPointerException - if asyncHttpClient is null

prepare

default io.reactivex.Maybe<Response> prepare(Request request)

Prepares the given request. For each subscription to the returned Maybe, a new HTTP request will be executed and its response will be emitted.

Parameters:

request - the request that is to be executed

Returns:

a Maybe that executes request upon subscription and emits the response

Throws:

NullPointerException - if request is null

prepare

<T> io.reactivex.Maybe<T> prepare(Request request,
                                  java.util.function.Supplier<? extends AsyncHandler<T>> handlerSupplier)

Prepares the given request. For each subscription to the returned Maybe, a new HTTP request will be executed and the results of AsyncHandlers obtained from handlerSupplier will be emitted.

Type Parameters:

T - the result type produced by handlers produced by handlerSupplier and emitted by the returned Maybe instance

Parameters:

request - the request that is to be executed

handlerSupplier - supplies the desired AsyncHandler instances that are used to produce results

Returns:

a Maybe that executes request upon subscription and that emits the results produced by the supplied handers

Throws:

NullPointerException - if at least one of the parameters is null