org.davidmoten.rx2.io

Class Client.Builder

java.lang.Object

org.davidmoten.rx2.io.Client.Builder

Enclosing class:

Client

public static final class Client.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
Client.Builder	basicAuth(String username, String password) Sets the Basic Authentication details for all HTTP connections (subscription, request and cancellation).
io.reactivex.Flowable<ByteBuffer>	build() Returns the built Flowable<ByteBuffer> based on all the builder options specified.
Client.Builder	connectTimeoutMs(int timeoutMs) Sets the connect timeout in ms for the HTTP connection.
<T extends Serializable> io.reactivex.Flowable<T>	deserialized() Returns the Flowable where deserialization is performed by Serializer.javaIo().
<T> io.reactivex.Flowable<T>	deserializer(Deserializer<T> serializer) Sets the deserializer to be used on the arriving ByteBuffers.
Client.Builder	proxy(Proxy proxy) Sets the proxy for the HTTP connection.
Client.Builder	proxy(String host, int port) Sets the proxy details for the HTTP connection.
Client.Builder	readTimeoutMs(int timeoutMs) Sets the read timeout in ms for the HTTP connection.
Client.Builder	requestHeader(String key, String value) Sets a request header for the HTTP connection.
Client.Builder	requestScheduler(io.reactivex.Scheduler scheduler)
Client.Builder	sslContext(SSLContext sslContext) Sets the SSLContext to be used for HTTP connections.
Client.Builder	sslSocketFactory(SSLSocketFactory sslSocketFactory) Sets the SSLSocketFactory to be used for HTTPS connections.
Client.Builder	transform(io.reactivex.functions.Consumer<HttpURLConnection> transform) Sets the actions that should be applied to HttpURLConnection before calling HttpURLConnection.getInputStream().

Methods inherited from class java.lang.Object

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

Method Detail

readTimeoutMs

public Client.Builder readTimeoutMs(int timeoutMs)

Sets the read timeout in ms for the HTTP connection. Default is zero which is advisable for a long-running occasionally quiet stream. When a read timeout occurs the Flowable will emit an error.

Parameters:

timeoutMs - read timeout for the HTTP connection.

Returns:

this

connectTimeoutMs

public Client.Builder connectTimeoutMs(int timeoutMs)

Sets the connect timeout in ms for the HTTP connection. Default is 30s which is When a read timeout occurs the Flowable will emit an error.

Parameters:

timeoutMs - connect timeout for the HTTP connection.

Returns:

this

proxy

public Client.Builder proxy(String host,
                            int port)

Sets the proxy details for the HTTP connection.

Parameters:

host - proxy host

port - proxy port

Returns:

this

proxy

public Client.Builder proxy(Proxy proxy)

Sets the proxy for the HTTP connection.

Parameters:

proxy - the proxy details

Returns:

this

transform

public Client.Builder transform(io.reactivex.functions.Consumer<HttpURLConnection> transform)

Sets the actions that should be applied to HttpURLConnection before calling HttpURLConnection.getInputStream(). This applies to all HTTP calls being the subscription, request and cancel calls.

Parameters:

transform - action to apply

Returns:

this

basicAuth

public Client.Builder basicAuth(String username,
                                String password)

Sets the Basic Authentication details for all HTTP connections (subscription, request and cancellation).

Parameters:

username - authentication username

password - authentication password

Returns:

this

requestHeader

public Client.Builder requestHeader(String key,
                                    String value)

Sets a request header for the HTTP connection.

Parameters:

key - request header key

value - request header value

Returns:

this

sslSocketFactory

public Client.Builder sslSocketFactory(SSLSocketFactory sslSocketFactory)

Sets the SSLSocketFactory to be used for HTTPS connections.

Parameters:

sslSocketFactory - ssl socket factory

Returns:

this

sslContext

public Client.Builder sslContext(SSLContext sslContext)

Sets the SSLContext to be used for HTTP connections. The socket factory will be obtained from the SSLContext.

Parameters:

sslContext - ssl context

Returns:

this

requestScheduler

public Client.Builder requestScheduler(io.reactivex.Scheduler scheduler)

deserializer

public <T> io.reactivex.Flowable<T> deserializer(Deserializer<T> serializer)

Sets the deserializer to be used on the arriving ByteBuffers.

Type Parameters:

T - stream type

Parameters:

serializer - the deserializer to be used

Returns:

this

deserialized

public <T extends Serializable> io.reactivex.Flowable<T> deserialized()

Returns the Flowable where deserialization is performed by Serializer.javaIo().

Type Parameters:

T - the Flowable result type

Returns:

the built Flowable

build

public io.reactivex.Flowable<ByteBuffer> build()

Returns the built Flowable<ByteBuffer> based on all the builder options specified.

Returns:

the built Flowable.