io.micronaut.http.client

Interface RxStreamingHttpClient

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, HttpClient, LifeCycle<HttpClient>, RxHttpClient, StreamingHttpClient

All Known Implementing Classes:

DefaultHttpClient

public interface RxStreamingHttpClient
extends StreamingHttpClient, RxHttpClient

Extended version of StreamingHttpClient that exposes an RxJava 2.x interface.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields inherited from interface io.micronaut.http.client.HttpClient

DEFAULT_ERROR_TYPE

Method Summary

Modifier and Type	Method and Description
static RxStreamingHttpClient	create(java.net.URL url) Create a new HttpClient.
static RxStreamingHttpClient	create(java.net.URL url, HttpClientConfiguration configuration) Create a new HttpClient with the specified configuration.
<I> io.reactivex.Flowable<ByteBuffer<?>>	dataStream(HttpRequest<I> request) Request a stream of data where each emitted item is a ByteBuffer instance.
<I> io.reactivex.Flowable<HttpResponse<ByteBuffer<?>>>	exchangeStream(HttpRequest<I> request) Requests a stream data where each emitted item is a ByteBuffer wrapped in the HttpResponse object (which remains the same for each emitted item).
<I> io.reactivex.Flowable<java.util.Map<java.lang.String,java.lang.Object>>	jsonStream(HttpRequest<I> request) Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.
<I,O> io.reactivex.Flowable<O>	jsonStream(HttpRequest<I> request, Argument<O> type) Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.
default <I,O> io.reactivex.Flowable<O>	jsonStream(HttpRequest<I> request, java.lang.Class<O> type) Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.

Methods inherited from interface io.micronaut.http.client.RxHttpClient

exchange, exchange, exchange, exchange, exchange, exchange, retrieve, retrieve, retrieve, retrieve, retrieve

Methods inherited from interface io.micronaut.http.client.HttpClient

refresh, toBlocking

Methods inherited from interface io.micronaut.context.LifeCycle

close, isRunning, start, stop

Method Detail

dataStream

<I> io.reactivex.Flowable<ByteBuffer<?>> dataStream(HttpRequest<I> request)

Description copied from interface: StreamingHttpClient

Request a stream of data where each emitted item is a ByteBuffer instance.

Specified by:

dataStream in interface StreamingHttpClient

Type Parameters:

I - The request body type

Parameters:

request - The request

Returns:

A Publisher that emits a stream of ByteBuffer instances

exchangeStream

<I> io.reactivex.Flowable<HttpResponse<ByteBuffer<?>>> exchangeStream(HttpRequest<I> request)

Description copied from interface: StreamingHttpClient

Requests a stream data where each emitted item is a ByteBuffer wrapped in the HttpResponse object (which remains the same for each emitted item).

Specified by:

exchangeStream in interface StreamingHttpClient

Type Parameters:

I - The request body type

Parameters:

request - The HttpRequest

Returns:

A Publisher that emits a stream of ByteBuffer instances wrapped by a HttpResponse

jsonStream

<I> io.reactivex.Flowable<java.util.Map<java.lang.String,java.lang.Object>> jsonStream(HttpRequest<I> request)

Description copied from interface: StreamingHttpClient

Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.

The downstream Subscriber can regulate demand via the subscription

Specified by:

jsonStream in interface StreamingHttpClient

Type Parameters:

I - The request body type

Parameters:

request - The HttpRequest to execute

Returns:

A Publisher that emits the full HttpResponse object

jsonStream

<I,O> io.reactivex.Flowable<O> jsonStream(HttpRequest<I> request,
                                          Argument<O> type)

Description copied from interface: StreamingHttpClient

Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.

The downstream Subscriber can regulate demand via the subscription. Incoming data is buffered.

Specified by:

jsonStream in interface StreamingHttpClient

Type Parameters:

I - The request body type

O - The response type

Parameters:

request - The HttpRequest to execute

type - The type of object to convert the JSON into

Returns:

A Publisher that emits the full HttpResponse object

jsonStream

default <I,O> io.reactivex.Flowable<O> jsonStream(HttpRequest<I> request,
                                                  java.lang.Class<O> type)

Description copied from interface: StreamingHttpClient

Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.

The downstream Subscriber can regulate demand via the subscription

Specified by:

jsonStream in interface StreamingHttpClient

Type Parameters:

I - The request body type

O - The response type

Parameters:

request - The HttpRequest to execute

type - The type of object to convert the JSON into

Returns:

A Publisher that emits the full HttpResponse object

create

static RxStreamingHttpClient create(java.net.URL url)

Create a new HttpClient. Note that this method should only be used outside of the context of an application. Within Micronaut use Inject to inject a client instead

Specified by:

create in interface HttpClient

Specified by:

create in interface RxHttpClient

Parameters:

url - The base URL

Returns:

The client

create

static RxStreamingHttpClient create(java.net.URL url,
                                    HttpClientConfiguration configuration)

Create a new HttpClient with the specified configuration. Note that this method should only be used outside of the context of an application. Within Micronaut use Inject to inject a client instead

Specified by:

create in interface HttpClient

Parameters:

url - The base URL

configuration - The client configuration

Returns:

The client

Since:

2.2.0