com.linkedin.r2.transport.http.client.common

Class AbstractNettyClient<Req extends com.linkedin.r2.message.Request,Res extends com.linkedin.r2.message.Response>

java.lang.Object

com.linkedin.r2.transport.http.client.common.AbstractNettyClient<Req,Res>

All Implemented Interfaces:

com.linkedin.r2.transport.common.bridge.client.TransportClient

Direct Known Subclasses:

AbstractNettyStreamClient, HttpNettyClient

public abstract class AbstractNettyClient<Req extends com.linkedin.r2.message.Request,Res extends com.linkedin.r2.message.Response>
extends java.lang.Object
implements com.linkedin.r2.transport.common.bridge.client.TransportClient

Abstract class implementation of TransportClient on top of Netty libraries. Inheriting this class is a good starting point for protocol specific implementation of TransportClient.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.ScheduledExecutorService	_scheduler
protected java.util.concurrent.atomic.AtomicReference<NettyClientState>	_state

Constructor Summary

Constructors

Constructor and Description
AbstractNettyClient(ChannelPoolFactory factory, java.util.concurrent.ScheduledExecutorService executor, int requestTimeout, int shutdownTimeout)
AbstractNettyClient(java.util.concurrent.ScheduledExecutorService executor, long requestTimeout, long shutdownTimeout, com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager, ChannelPoolManager channelPoolManager, ChannelPoolManager sslChannelPoolManager) Creates a new HttpNettyClient

Method Summary

Modifier and Type	Method and Description
protected abstract void	doWriteRequest(Req request, com.linkedin.r2.message.RequestContext context, java.net.SocketAddress address, java.util.Map<java.lang.String,java.lang.String> wireAttrs, com.linkedin.r2.transport.http.client.TimeoutTransportCallback<Res> callback, long requestTimeout) Writes the given request to the given socket address and invokes the callback after request is sent.
static <T> void	errorResponse(com.linkedin.r2.transport.common.bridge.common.TransportCallback<T> callback, java.lang.Throwable e)
protected ChannelPoolManager	getChannelPoolManagerPerRequest(com.linkedin.r2.message.Request request)
protected abstract com.linkedin.r2.transport.common.bridge.common.TransportCallback<Res>	getExecutionCallback(com.linkedin.r2.transport.common.bridge.common.TransportCallback<Res> callback) Given a callback, returns the wrapped callback that will be executed on a custom executor
java.util.Map<java.lang.String,com.linkedin.r2.transport.http.client.PoolStats>	getPoolStats() Gets statistics from each channel pool.
void	restRequest(com.linkedin.r2.message.rest.RestRequest request, com.linkedin.r2.message.RequestContext requestContext, java.util.Map<java.lang.String,java.lang.String> wireAttrs, com.linkedin.r2.transport.common.bridge.common.TransportCallback<com.linkedin.r2.message.rest.RestResponse> callback)
void	shutdown(com.linkedin.common.callback.Callback<com.linkedin.common.util.None> callback)
void	streamRequest(com.linkedin.r2.message.stream.StreamRequest request, com.linkedin.r2.message.RequestContext requestContext, java.util.Map<java.lang.String,java.lang.String> wireAttrs, com.linkedin.r2.transport.common.bridge.common.TransportCallback<com.linkedin.r2.message.stream.StreamResponse> callback)
static java.lang.Exception	toException(java.lang.Throwable t)

Methods inherited from class java.lang.Object

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

Field Detail

_state

protected final java.util.concurrent.atomic.AtomicReference<NettyClientState> _state

_scheduler

protected final java.util.concurrent.ScheduledExecutorService _scheduler

Constructor Detail

AbstractNettyClient

public AbstractNettyClient(java.util.concurrent.ScheduledExecutorService executor,
                           long requestTimeout,
                           long shutdownTimeout,
                           com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager,
                           ChannelPoolManager channelPoolManager,
                           ChannelPoolManager sslChannelPoolManager)

Creates a new HttpNettyClient

Parameters:

executor - An executor; it is the caller's responsibility to shut it down

requestTimeout - Timeout, in ms, to get a connection from the pool or create one

shutdownTimeout - Timeout, in ms, the client should wait after shutdown is initiated before terminating outstanding requests

jmxManager - A management class that is aware of the creation/shutdown event of the underlying ChannelPoolManager

channelPoolManager - channelPoolManager instance to retrieve http only channels

sslChannelPoolManager - channelPoolManager instance to retrieve https only connection

AbstractNettyClient

public AbstractNettyClient(ChannelPoolFactory factory,
                           java.util.concurrent.ScheduledExecutorService executor,
                           int requestTimeout,
                           int shutdownTimeout)

Method Detail

getExecutionCallback

protected abstract com.linkedin.r2.transport.common.bridge.common.TransportCallback<Res> getExecutionCallback(com.linkedin.r2.transport.common.bridge.common.TransportCallback<Res> callback)

Given a callback, returns the wrapped callback that will be executed on a custom executor

doWriteRequest

protected abstract void doWriteRequest(Req request,
                                       com.linkedin.r2.message.RequestContext context,
                                       java.net.SocketAddress address,
                                       java.util.Map<java.lang.String,java.lang.String> wireAttrs,
                                       com.linkedin.r2.transport.http.client.TimeoutTransportCallback<Res> callback,
                                       long requestTimeout)

Writes the given request to the given socket address and invokes the callback after request is sent.

Parameters:

request - Request to send

context - Request context

address - Socket address to send the request to

wireAttrs - attributes that should be sent over the wire to the server

callback - Callback invoked after request is sent

restRequest

public void restRequest(com.linkedin.r2.message.rest.RestRequest request,
                        com.linkedin.r2.message.RequestContext requestContext,
                        java.util.Map<java.lang.String,java.lang.String> wireAttrs,
                        com.linkedin.r2.transport.common.bridge.common.TransportCallback<com.linkedin.r2.message.rest.RestResponse> callback)

Specified by:

restRequest in interface com.linkedin.r2.transport.common.bridge.client.TransportClient

streamRequest

public void streamRequest(com.linkedin.r2.message.stream.StreamRequest request,
                          com.linkedin.r2.message.RequestContext requestContext,
                          java.util.Map<java.lang.String,java.lang.String> wireAttrs,
                          com.linkedin.r2.transport.common.bridge.common.TransportCallback<com.linkedin.r2.message.stream.StreamResponse> callback)

Specified by:

streamRequest in interface com.linkedin.r2.transport.common.bridge.client.TransportClient

getChannelPoolManagerPerRequest

protected ChannelPoolManager getChannelPoolManagerPerRequest(com.linkedin.r2.message.Request request)

shutdown

public final void shutdown(com.linkedin.common.callback.Callback<com.linkedin.common.util.None> callback)

Specified by:

shutdown in interface com.linkedin.r2.transport.common.bridge.client.TransportClient

errorResponse

public static <T> void errorResponse(com.linkedin.r2.transport.common.bridge.common.TransportCallback<T> callback,
                                     java.lang.Throwable e)

toException

public static java.lang.Exception toException(java.lang.Throwable t)

getPoolStats

public final java.util.Map<java.lang.String,com.linkedin.r2.transport.http.client.PoolStats> getPoolStats()

Gets statistics from each channel pool. The map keys represent pool names. The values are the corresponding AsyncPoolStats objects.

Returns:

A map of pool names and statistics.