com.netflix.ribbon.transport.netty.http

Class LoadBalancingHttpClient<I,O>

java.lang.Object

com.netflix.ribbon.transport.netty.LoadBalancingRxClient<I,O,T>

com.netflix.ribbon.transport.netty.LoadBalancingRxClientWithPoolOptions<io.reactivex.netty.protocol.http.client.HttpClientRequest<I>,io.reactivex.netty.protocol.http.client.HttpClientResponse<O>,io.reactivex.netty.protocol.http.client.HttpClient<I,O>>

com.netflix.ribbon.transport.netty.http.LoadBalancingHttpClient<I,O>

All Implemented Interfaces:

io.reactivex.netty.client.RxClient<io.reactivex.netty.protocol.http.client.HttpClientRequest<I>,io.reactivex.netty.protocol.http.client.HttpClientResponse<O>>, io.reactivex.netty.metrics.MetricEventsPublisher<io.reactivex.netty.client.ClientMetricsEvent<?>>, io.reactivex.netty.protocol.http.client.HttpClient<I,O>

Direct Known Subclasses:

SSEClient

public class LoadBalancingHttpClient<I,O>
extends LoadBalancingRxClientWithPoolOptions<io.reactivex.netty.protocol.http.client.HttpClientRequest<I>,io.reactivex.netty.protocol.http.client.HttpClientResponse<O>,io.reactivex.netty.protocol.http.client.HttpClient<I,O>>
implements io.reactivex.netty.protocol.http.client.HttpClient<I,O>

A Netty HttpClient that can connect to different servers. Internally it caches the RxNetty's HttpClient, with each created with a connection pool governed by CompositePoolLimitDeterminationStrategy that has a global limit and per server limit.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoadBalancingHttpClient.Builder<I,O>

Nested classes/interfaces inherited from interface io.reactivex.netty.protocol.http.client.HttpClient

io.reactivex.netty.protocol.http.client.HttpClient.HttpClientConfig

Nested classes/interfaces inherited from interface io.reactivex.netty.client.RxClient

io.reactivex.netty.client.RxClient.ClientConfig, io.reactivex.netty.client.RxClient.ServerInfo

Field Summary

Fields inherited from class com.netflix.ribbon.transport.netty.LoadBalancingRxClientWithPoolOptions

globalStrategy, idleConnectionEvictionMills, poolCleanerScheduler, poolEnabled, poolStrategy

Fields inherited from class com.netflix.ribbon.transport.netty.LoadBalancingRxClient

clientConfig, defaultRetryHandler, eventSubject, lbContext, listener, pipelineConfigurator, rxClientCache, sslContextFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LoadBalancingHttpClient(LoadBalancingHttpClient.Builder<I,O> builder)

Method Summary

Modifier and Type	Method and Description
static <I,O> LoadBalancingHttpClient.Builder<I,O>	builder()
protected io.reactivex.netty.metrics.MetricEventsListener<? extends io.reactivex.netty.client.ClientMetricsEvent<?>>	createListener(java.lang.String name)
protected io.reactivex.netty.protocol.http.client.HttpClient<I,O>	createRxClient(com.netflix.loadbalancer.Server server) Create a client instance for this Server.
protected com.netflix.loadbalancer.reactive.ServerOperation<io.reactivex.netty.protocol.http.client.HttpClientResponse<O>>	requestToOperation(io.reactivex.netty.protocol.http.client.HttpClientRequest<I> request, io.reactivex.netty.client.RxClient.ClientConfig rxClientConfig) Convert an HttpClientRequest to a ServerOperation
protected static void	setHostHeader(io.reactivex.netty.protocol.http.client.HttpClientRequest<?> request, java.lang.String host)
rx.Observable<io.reactivex.netty.protocol.http.client.HttpClientResponse<O>>	submit(io.reactivex.netty.protocol.http.client.HttpClientRequest<I> request) Submit a request to server chosen by the load balancer to execute.
rx.Observable<io.reactivex.netty.protocol.http.client.HttpClientResponse<O>>	submit(io.reactivex.netty.protocol.http.client.HttpClientRequest<I> request, com.netflix.client.RetryHandler errorHandler, com.netflix.client.config.IClientConfig requestConfig) Submit a request to server chosen by the load balancer to execute.
rx.Observable<io.reactivex.netty.protocol.http.client.HttpClientResponse<O>>	submit(io.reactivex.netty.protocol.http.client.HttpClientRequest<I> request, io.reactivex.netty.client.RxClient.ClientConfig config) Submit a request to server chosen by the load balancer to execute.
rx.Observable<io.reactivex.netty.protocol.http.client.HttpClientResponse<O>>	submit(com.netflix.loadbalancer.Server server, io.reactivex.netty.protocol.http.client.HttpClientRequest<I> request)
rx.Observable<io.reactivex.netty.protocol.http.client.HttpClientResponse<O>>	submit(com.netflix.loadbalancer.Server server, io.reactivex.netty.protocol.http.client.HttpClientRequest<I> request, com.netflix.client.config.IClientConfig requestConfig) Submit a request to run on a specific server

Methods inherited from class com.netflix.ribbon.transport.netty.LoadBalancingRxClientWithPoolOptions

getConnectionIdleTimeoutMillis, getMaxConcurrentRequests, getPoolStrategy, isPoolEnabled

Methods inherited from class com.netflix.ribbon.transport.netty.LoadBalancingRxClient

connect, getClientConfig, getLoadBalancerContext, getOrCreateRxClient, getProperty, getResourceForOptionalProperty, getResponseTimeOut, name, removeClient, shutdown, subscribe

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.reactivex.netty.client.RxClient

connect, name, shutdown

Methods inherited from interface io.reactivex.netty.metrics.MetricEventsPublisher

subscribe

Constructor Detail

LoadBalancingHttpClient

protected LoadBalancingHttpClient(LoadBalancingHttpClient.Builder<I,O> builder)

Method Detail

builder

public static <I,O> LoadBalancingHttpClient.Builder<I,O> builder()

setHostHeader

protected static void setHostHeader(io.reactivex.netty.protocol.http.client.HttpClientRequest<?> request,
                                    java.lang.String host)

submit

public rx.Observable<io.reactivex.netty.protocol.http.client.HttpClientResponse<O>> submit(io.reactivex.netty.protocol.http.client.HttpClientRequest<I> request)

Submit a request to server chosen by the load balancer to execute. An error will be emitted from the returned Observable if there is no server available from load balancer.

Specified by:

submit in interface io.reactivex.netty.protocol.http.client.HttpClient<I,O>

submit

public rx.Observable<io.reactivex.netty.protocol.http.client.HttpClientResponse<O>> submit(io.reactivex.netty.protocol.http.client.HttpClientRequest<I> request,
                                                                                           io.reactivex.netty.client.RxClient.ClientConfig config)

Submit a request to server chosen by the load balancer to execute. An error will be emitted from the returned Observable if there is no server available from load balancer.

Specified by:

submit in interface io.reactivex.netty.protocol.http.client.HttpClient<I,O>

Parameters:

config - An ClientConfig to override the default configuration for the client. Can be null.

Returns:

submit

public rx.Observable<io.reactivex.netty.protocol.http.client.HttpClientResponse<O>> submit(com.netflix.loadbalancer.Server server,
                                                                                           io.reactivex.netty.protocol.http.client.HttpClientRequest<I> request,
                                                                                           com.netflix.client.config.IClientConfig requestConfig)

Submit a request to run on a specific server

Parameters:

server -

request -

requestConfig -

Returns:

submit

public rx.Observable<io.reactivex.netty.protocol.http.client.HttpClientResponse<O>> submit(io.reactivex.netty.protocol.http.client.HttpClientRequest<I> request,
                                                                                           com.netflix.client.RetryHandler errorHandler,
                                                                                           com.netflix.client.config.IClientConfig requestConfig)

Submit a request to server chosen by the load balancer to execute. An error will be emitted from the returned Observable if there is no server available from load balancer.

Parameters:

errorHandler - A handler to determine the load balancer retry logic. If null, the default one will be used.

requestConfig - An IClientConfig to override the default configuration for the client. Can be null.

Returns:

submit

public rx.Observable<io.reactivex.netty.protocol.http.client.HttpClientResponse<O>> submit(com.netflix.loadbalancer.Server server,
                                                                                           io.reactivex.netty.protocol.http.client.HttpClientRequest<I> request)

requestToOperation

protected com.netflix.loadbalancer.reactive.ServerOperation<io.reactivex.netty.protocol.http.client.HttpClientResponse<O>> requestToOperation(io.reactivex.netty.protocol.http.client.HttpClientRequest<I> request,
                                                                                                                                              io.reactivex.netty.client.RxClient.ClientConfig rxClientConfig)

Convert an HttpClientRequest to a ServerOperation

Parameters:

server -

request -

rxClientConfig -

Returns:

createRxClient

protected io.reactivex.netty.protocol.http.client.HttpClient<I,O> createRxClient(com.netflix.loadbalancer.Server server)

Description copied from class: LoadBalancingRxClient

Create a client instance for this Server. Note that only the client object is created here but that the client connection is not created yet.

Specified by:

createRxClient in class LoadBalancingRxClient<io.reactivex.netty.protocol.http.client.HttpClientRequest<I>,io.reactivex.netty.protocol.http.client.HttpClientResponse<O>,io.reactivex.netty.protocol.http.client.HttpClient<I,O>>

Returns:

createListener

protected io.reactivex.netty.metrics.MetricEventsListener<? extends io.reactivex.netty.client.ClientMetricsEvent<?>> createListener(java.lang.String name)

Specified by:

createListener in class LoadBalancingRxClient<io.reactivex.netty.protocol.http.client.HttpClientRequest<I>,io.reactivex.netty.protocol.http.client.HttpClientResponse<O>,io.reactivex.netty.protocol.http.client.HttpClient<I,O>>