io.micronaut.rxjava3.http.client

Interface Rx3StreamingHttpClient

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, io.micronaut.http.client.HttpClient, io.micronaut.context.LifeCycle<io.micronaut.http.client.HttpClient>, Rx3HttpClient, io.micronaut.http.client.StreamingHttpClient

public interface Rx3StreamingHttpClient
extends Rx3HttpClient, io.micronaut.http.client.StreamingHttpClient

RxJava 3 variation of the StreamingHttpClient interface.

Since:

1.0.0

Author:

graemerocher

Field Summary

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

DEFAULT_ERROR_TYPE

Method Summary

Modifier and Type	Method and Description
static Rx3StreamingHttpClient	create(java.net.URL url) Create a new Rx3StreamingHttpClient.
static Rx3StreamingHttpClient	create(java.net.URL url, io.micronaut.http.client.HttpClientConfiguration configuration) Create a new Rx3StreamingHttpClient with the specified configuration.
<I> io.reactivex.rxjava3.core.Flowable<io.micronaut.core.io.buffer.ByteBuffer<?>>	dataStream(io.micronaut.http.HttpRequest<I> request)
<I> io.reactivex.rxjava3.core.Flowable<io.micronaut.http.HttpResponse<io.micronaut.core.io.buffer.ByteBuffer<?>>>	exchangeStream(io.micronaut.http.HttpRequest<I> request)
<I> io.reactivex.rxjava3.core.Flowable<java.util.Map<java.lang.String,java.lang.Object>>	jsonStream(io.micronaut.http.HttpRequest<I> request)
<I,O> io.reactivex.rxjava3.core.Flowable<O>	jsonStream(io.micronaut.http.HttpRequest<I> request, io.micronaut.core.type.Argument<O> type)
<I,O> io.reactivex.rxjava3.core.Flowable<O>	jsonStream(io.micronaut.http.HttpRequest<I> request, java.lang.Class<O> type)

Methods inherited from interface io.micronaut.rxjava3.http.client.Rx3HttpClient

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

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

dataStream, exchangeStream, jsonStream

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.rxjava3.core.Flowable<io.micronaut.core.io.buffer.ByteBuffer<?>> dataStream(@NonNull
                                                                                             io.micronaut.http.HttpRequest<I> request)

Specified by:

dataStream in interface io.micronaut.http.client.StreamingHttpClient

exchangeStream

<I> io.reactivex.rxjava3.core.Flowable<io.micronaut.http.HttpResponse<io.micronaut.core.io.buffer.ByteBuffer<?>>> exchangeStream(@NonNull
                                                                                                                                 io.micronaut.http.HttpRequest<I> request)

Specified by:

exchangeStream in interface io.micronaut.http.client.StreamingHttpClient

jsonStream

<I> io.reactivex.rxjava3.core.Flowable<java.util.Map<java.lang.String,java.lang.Object>> jsonStream(@NonNull
                                                                                                    io.micronaut.http.HttpRequest<I> request)

Specified by:

jsonStream in interface io.micronaut.http.client.StreamingHttpClient

jsonStream

<I,O> io.reactivex.rxjava3.core.Flowable<O> jsonStream(@NonNull
                                                       io.micronaut.http.HttpRequest<I> request,
                                                       @NonNull
                                                       io.micronaut.core.type.Argument<O> type)

Specified by:

jsonStream in interface io.micronaut.http.client.StreamingHttpClient

jsonStream

<I,O> io.reactivex.rxjava3.core.Flowable<O> jsonStream(@NonNull
                                                       io.micronaut.http.HttpRequest<I> request,
                                                       @NonNull
                                                       java.lang.Class<O> type)

Specified by:

jsonStream in interface io.micronaut.http.client.StreamingHttpClient

create

static Rx3StreamingHttpClient create(@Nullable
                                     java.net.URL url)

Create a new Rx3StreamingHttpClient. Note that this method should only be used outside of the context of a Micronaut application. The returned Rx3StreamingHttpClient is not subject to dependency injection. The creator is responsible for closing the client to avoid leaking connections. Within a Micronaut application use Inject to inject a client instead.

Specified by:

create in interface io.micronaut.http.client.HttpClient

Specified by:

create in interface Rx3HttpClient

Specified by:

create in interface io.micronaut.http.client.StreamingHttpClient

Parameters:

url - The base URL

Returns:

The client

Since:

2.1.0

create

static Rx3StreamingHttpClient create(@Nullable
                                     java.net.URL url,
                                     @NonNull
                                     io.micronaut.http.client.HttpClientConfiguration configuration)

Create a new Rx3StreamingHttpClient 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 io.micronaut.http.client.HttpClient

Specified by:

create in interface Rx3HttpClient

Specified by:

create in interface io.micronaut.http.client.StreamingHttpClient

Parameters:

url - The base URL

configuration - the client configuration

Returns:

The client

Since:

2.1.0