net.gdface.thrift

Class ClientFactory

java.lang.Object

net.gdface.thrift.ClientFactory

public class ClientFactory
extends java.lang.Object

Factory class for creating client instance
Example:

 // get a FaceApi synchronized instance
 FaceApi client = ClientFactory.builder()
 .setHostAndPort("127.0.0.1",9090)
 .setTimeout(10,TimeUnit.SECONDS)
 .build(FaceApi.class,FaceApiThriftClient.class);
 

Author:

guyadong

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ClientFactory.ListenableFutureDecorator<A,V> ListenableFuture接口的装饰类， 用于确保异步调用结束时释放异步接口实例,参见releaseInstance(Object)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientFactory()

Method Summary

Modifier and Type	Method and Description
<V> void	addCallback(com.google.common.util.concurrent.ListenableFuture<V> future, com.google.common.util.concurrent.FutureCallback<? super V> callback)
<T> T	applyInstance(java.lang.Class<T> interfaceClass) thrift client 实例不是线程安全的，只可单线程独占使用，所以每次调用实例时要向资源池GenericObjectPool 申请一个interfaceClass的实例,用完后调用releaseInstance(Object)归还,其他线程才可重复使用。
<I,T extends I,O> O	build(java.lang.Class<I> interfaceClass, java.lang.Class<T> thriftyImplClass, java.lang.Class<O> destClass) 构造interfaceClass实例 thriftyImplClass为null时,假设destClass为thrifty 异步实例类型
<I,O,T extends I> O	build(java.lang.Class<T> thriftyImplClass, java.lang.Class<O> destClass) 构造interfaceClass实例 build(Class, Class, Class)的简化版本，当thriftImplClass只实现了一个接口时，自动推断接口类型
static ClientFactory	builder()
<T> void	closeObjectPool(java.lang.Class<T> interfaceClass)
java.util.concurrent.Executor	getExecutor()
com.google.common.net.HostAndPort	getHostAndPort()
<T> void	releaseInstance(T instance) 释放instance实例使用权,必须和applyInstance(Class)配对使用
ClientFactory	setClientName(java.lang.String clientName)
ClientFactory	setConnector(com.facebook.nifty.client.NiftyClientConnector<? extends com.facebook.nifty.client.NiftyClientChannel> connector)
ClientFactory	setConnectTimeout(io.airlift.units.Duration connectTimeout)
<T> ClientFactory	setDecorator(com.google.common.base.Function<T,T> decorator)
ClientFactory	setExecutor(java.util.concurrent.Executor executor)
ClientFactory	setHostAndPort(com.google.common.net.HostAndPort hostAndPort)
ClientFactory	setHostAndPort(java.lang.String host)
ClientFactory	setHostAndPort(java.lang.String host, int port)
ClientFactory	setManager(com.facebook.swift.service.ThriftClientManager clientManager)
ClientFactory	setMaxFrameSize(int maxFrameSize)
ClientFactory	setPoolConfig(org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig) 设置资源池配置参数
ClientFactory	setReadTimeout(io.airlift.units.Duration readTimeout)
ClientFactory	setReceiveTimeout(io.airlift.units.Duration receiveTimeout)
ClientFactory	setSocksProxy(com.google.common.net.HostAndPort socksProxy)
ClientFactory	setThriftClientConfig(com.facebook.swift.service.ThriftClientConfig thriftClientConfig)
ClientFactory	setTimeout(io.airlift.units.Duration timeout) set all timeout arguments
ClientFactory	setTimeout(long time, java.util.concurrent.TimeUnit unit)
ClientFactory	setWriteTimeout(io.airlift.units.Duration writeTimeout)
boolean	testConnect() 测试当前连接是否有效
java.lang.String	toString()
<A,V> ClientFactory.ListenableFutureDecorator<A,V>	wrap(A async, com.google.common.util.concurrent.ListenableFuture<V> future) 将future 封装为ClientFactory.ListenableFutureDecorator实例

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientFactory

protected ClientFactory()

Method Detail

setManager

public ClientFactory setManager(com.facebook.swift.service.ThriftClientManager clientManager)

setThriftClientConfig

public ClientFactory setThriftClientConfig(com.facebook.swift.service.ThriftClientConfig thriftClientConfig)

setTimeout

public ClientFactory setTimeout(io.airlift.units.Duration timeout)

set all timeout arguments

Parameters:

time -

unit -

Returns:

See Also:

setConnectTimeout(Duration), setReceiveTimeout(Duration), setReadTimeout(Duration), setWriteTimeout(Duration)

setTimeout

public ClientFactory setTimeout(long time,
                                java.util.concurrent.TimeUnit unit)

setConnectTimeout

public ClientFactory setConnectTimeout(io.airlift.units.Duration connectTimeout)

setReceiveTimeout

public ClientFactory setReceiveTimeout(io.airlift.units.Duration receiveTimeout)

setReadTimeout

public ClientFactory setReadTimeout(io.airlift.units.Duration readTimeout)

setWriteTimeout

public ClientFactory setWriteTimeout(io.airlift.units.Duration writeTimeout)

setSocksProxy

public ClientFactory setSocksProxy(com.google.common.net.HostAndPort socksProxy)

setMaxFrameSize

public ClientFactory setMaxFrameSize(int maxFrameSize)

setHostAndPort

public ClientFactory setHostAndPort(com.google.common.net.HostAndPort hostAndPort)

setHostAndPort

public ClientFactory setHostAndPort(java.lang.String host,
                                    int port)

setHostAndPort

public ClientFactory setHostAndPort(java.lang.String host)

setConnector

public ClientFactory setConnector(com.facebook.nifty.client.NiftyClientConnector<? extends com.facebook.nifty.client.NiftyClientChannel> connector)

setClientName

public ClientFactory setClientName(java.lang.String clientName)

setPoolConfig

public ClientFactory setPoolConfig(org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig)

设置资源池配置参数

Parameters:

poolConfig -

Returns:

setExecutor

public ClientFactory setExecutor(java.util.concurrent.Executor executor)

getExecutor

public java.util.concurrent.Executor getExecutor()

setDecorator

public <T> ClientFactory setDecorator(com.google.common.base.Function<T,T> decorator)

getHostAndPort

public com.google.common.net.HostAndPort getHostAndPort()

closeObjectPool

public <T> void closeObjectPool(java.lang.Class<T> interfaceClass)

applyInstance

public <T> T applyInstance(java.lang.Class<T> interfaceClass)

thrift client 实例不是线程安全的，只可单线程独占使用，所以每次调用实例时要向资源池GenericObjectPool 申请一个interfaceClass的实例,用完后调用releaseInstance(Object)归还,其他线程才可重复使用。

Parameters:

interfaceClass - 接口类，不可为null

Returns:

releaseInstance

public <T> void releaseInstance(T instance)

释放instance实例使用权,必须和applyInstance(Class)配对使用

Parameters:

instance - 接口实例

builder

public static ClientFactory builder()

build

public <I,T extends I,O> O build(java.lang.Class<I> interfaceClass,
                                 java.lang.Class<T> thriftyImplClass,
                                 java.lang.Class<O> destClass)

构造interfaceClass实例
thriftyImplClass为null时,假设destClass为thrifty 异步实例类型

Type Parameters:

I - 接口类

O - 返回实例类型

T - 基于thrifty实现接口类的实例类型

Parameters:

interfaceClass -

thriftyImplClass -

destClass - 返回的实例类型，如果interfaceClass和thriftyImplClass为null,必须有参数为ClientFactory的构造函数 否则必须有参数类型为interfaceClass的构造函数

Returns:

返回 destClass 实例

build

public <I,O,T extends I> O build(java.lang.Class<T> thriftyImplClass,
                                 java.lang.Class<O> destClass)

构造interfaceClass实例
build(Class, Class, Class)的简化版本，当thriftImplClass只实现了一个接口时，自动推断接口类型

Parameters:

thriftyImplClass -

destClass -

Returns:

See Also:

build(Class, Class, Class)

testConnect

public boolean testConnect()

测试当前连接是否有效

Returns:

连接有效返回true,否则返回false

addCallback

public <V> void addCallback(com.google.common.util.concurrent.ListenableFuture<V> future,
                            com.google.common.util.concurrent.FutureCallback<? super V> callback)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

wrap

public <A,V> ClientFactory.ListenableFutureDecorator<A,V> wrap(A async,
                                                               com.google.common.util.concurrent.ListenableFuture<V> future)

将future 封装为ClientFactory.ListenableFutureDecorator实例

Parameters:

async - thrift 异步接口实例

future - 异步返回结果实例

Returns:

ClientFactory.ListenableFutureDecorator实例