com.jakewharton.retrofit2.adapter.reactor

Class ReactorCallAdapterFactory

java.lang.Object

retrofit2.CallAdapter.Factory

com.jakewharton.retrofit2.adapter.reactor.ReactorCallAdapterFactory

public final class ReactorCallAdapterFactory
extends retrofit2.CallAdapter.Factory

A call adapter which uses Project Reactor for creating streams.

Adding this class to Retrofit allows you to return a Flux or Mono from service methods.

 interface MyService {
   @GET("user/me")
   Flux<User> getUser()
 }
 

There are three configurations supported for the Flux or Mono type parameter:

• Direct body (e.g., Flux<User>) calls onNext with the deserialized body for 2XX responses and calls onError with HttpException for non-2XX responses and IOException for network errors.
• Response wrapped body (e.g., Flux<Response<User>>) calls onNext with a Response object for all HTTP responses and calls onError with IOException for network errors
• Result wrapped body (e.g., Flux<Result<User>>) calls onNext with a Result object for all HTTP responses and errors.

Method Summary

Modifier and Type	Method and Description
static ReactorCallAdapterFactory	create() Returns an instance which creates synchronous observables that do not operate on any scheduler by default.
static ReactorCallAdapterFactory	createAsync() Returns an instance which creates asynchronous observables.
static ReactorCallAdapterFactory	createWithScheduler(reactor.core.scheduler.Scheduler scheduler) Returns an instance which creates synchronous observables that publishes on scheduler by default.
retrofit2.CallAdapter<?,?>	get(java.lang.reflect.Type returnType, java.lang.annotation.Annotation[] annotations, retrofit2.Retrofit retrofit)

Methods inherited from class retrofit2.CallAdapter.Factory

getParameterUpperBound, getRawType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static ReactorCallAdapterFactory create()

Returns an instance which creates synchronous observables that do not operate on any scheduler by default.

createAsync

public static ReactorCallAdapterFactory createAsync()

Returns an instance which creates asynchronous observables. Applying Flux.subscribeOn(reactor.core.scheduler.Scheduler) has no effect on stream types created by this factory.

createWithScheduler

public static ReactorCallAdapterFactory createWithScheduler(reactor.core.scheduler.Scheduler scheduler)

Returns an instance which creates synchronous observables that publishes on scheduler by default.

get

public retrofit2.CallAdapter<?,?> get(java.lang.reflect.Type returnType,
                                      java.lang.annotation.Annotation[] annotations,
                                      retrofit2.Retrofit retrofit)

Specified by:

get in class retrofit2.CallAdapter.Factory