com.linkedin.r2.transport.http.client.stream

Class AbstractNettyStreamClient

java.lang.Object

com.linkedin.r2.transport.http.client.common.AbstractNettyClient<com.linkedin.r2.message.stream.StreamRequest,com.linkedin.r2.message.stream.StreamResponse>

com.linkedin.r2.transport.http.client.stream.AbstractNettyStreamClient

All Implemented Interfaces:

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

Direct Known Subclasses:

Http2NettyStreamClient, HttpNettyStreamClient

public abstract class AbstractNettyStreamClient
extends AbstractNettyClient<com.linkedin.r2.message.stream.StreamRequest,com.linkedin.r2.message.stream.StreamResponse>

Abstract stream based 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 inherited from class com.linkedin.r2.transport.http.client.common.AbstractNettyClient

_scheduler, _state

Constructor Summary

Constructors

Constructor and Description
AbstractNettyStreamClient(ChannelPoolFactory factory, java.util.concurrent.ScheduledExecutorService executor, int requestTimeout, int shutdownTimeout)
AbstractNettyStreamClient(io.netty.channel.EventLoopGroup eventLoopGroup, java.util.concurrent.ScheduledExecutorService executor, long requestTimeout, long shutdownTimeout, java.util.concurrent.ExecutorService callbackExecutors, 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 void	doWriteRequest(com.linkedin.r2.message.stream.StreamRequest request, com.linkedin.r2.message.RequestContext requestContext, java.net.SocketAddress address, java.util.Map<java.lang.String,java.lang.String> wireAttrs, com.linkedin.r2.transport.http.client.TimeoutTransportCallback<com.linkedin.r2.message.stream.StreamResponse> callback, long requestTimeout) Writes the given request to the given socket address and invokes the callback after request is sent.
protected abstract void	doWriteRequestWithWireAttrHeaders(com.linkedin.r2.message.Request request, com.linkedin.r2.message.RequestContext requestContext, java.net.SocketAddress address, java.util.Map<java.lang.String,java.lang.String> wireAttrs, com.linkedin.r2.transport.http.client.TimeoutTransportCallback<com.linkedin.r2.message.stream.StreamResponse> callback, long requestTimeout)
protected com.linkedin.r2.transport.common.bridge.common.TransportCallback<com.linkedin.r2.message.stream.StreamResponse>	getExecutionCallback(com.linkedin.r2.transport.common.bridge.common.TransportCallback<com.linkedin.r2.message.stream.StreamResponse> callback) Given a callback, returns the wrapped callback that will be executed on a custom executor
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)

Methods inherited from class com.linkedin.r2.transport.http.client.common.AbstractNettyClient

errorResponse, getChannelPoolManagerPerRequest, getPoolStats, shutdown, streamRequest, toException

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNettyStreamClient

public AbstractNettyStreamClient(io.netty.channel.EventLoopGroup eventLoopGroup,
                                 java.util.concurrent.ScheduledExecutorService executor,
                                 long requestTimeout,
                                 long shutdownTimeout,
                                 java.util.concurrent.ExecutorService callbackExecutors,
                                 com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager,
                                 ChannelPoolManager channelPoolManager,
                                 ChannelPoolManager sslChannelPoolManager)

Creates a new HttpNettyClient

Parameters:

eventLoopGroup - The EventLoopGroup; it is the caller's responsibility to shut it down

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

callbackExecutors - An optional EventExecutorGroup to invoke user callback

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

AbstractNettyStreamClient

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

Method Detail

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

Overrides:

restRequest in class AbstractNettyClient<com.linkedin.r2.message.stream.StreamRequest,com.linkedin.r2.message.stream.StreamResponse>

getExecutionCallback

protected com.linkedin.r2.transport.common.bridge.common.TransportCallback<com.linkedin.r2.message.stream.StreamResponse> getExecutionCallback(com.linkedin.r2.transport.common.bridge.common.TransportCallback<com.linkedin.r2.message.stream.StreamResponse> callback)

Description copied from class: AbstractNettyClient

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

Specified by:

getExecutionCallback in class AbstractNettyClient<com.linkedin.r2.message.stream.StreamRequest,com.linkedin.r2.message.stream.StreamResponse>

doWriteRequestWithWireAttrHeaders

protected abstract void doWriteRequestWithWireAttrHeaders(com.linkedin.r2.message.Request request,
                                                          com.linkedin.r2.message.RequestContext requestContext,
                                                          java.net.SocketAddress address,
                                                          java.util.Map<java.lang.String,java.lang.String> wireAttrs,
                                                          com.linkedin.r2.transport.http.client.TimeoutTransportCallback<com.linkedin.r2.message.stream.StreamResponse> callback,
                                                          long requestTimeout)

doWriteRequest

protected void doWriteRequest(com.linkedin.r2.message.stream.StreamRequest request,
                              com.linkedin.r2.message.RequestContext requestContext,
                              java.net.SocketAddress address,
                              java.util.Map<java.lang.String,java.lang.String> wireAttrs,
                              com.linkedin.r2.transport.http.client.TimeoutTransportCallback<com.linkedin.r2.message.stream.StreamResponse> callback,
                              long requestTimeout)

Description copied from class: AbstractNettyClient

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

Specified by:

doWriteRequest in class AbstractNettyClient<com.linkedin.r2.message.stream.StreamRequest,com.linkedin.r2.message.stream.StreamResponse>

Parameters:

request - Request to send

requestContext - 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