ClientConfig (harpc 1.2 API)

java.lang.Object
- com.bfd.harpc.config.ClientConfig<T>

所有已实现的接口:

IConfigCheck

直接已知子类:

ClientBean
```
public class ClientConfig<T>
extends Object
implements IConfigCheck
```
服务消费者配置

作者:

: dsfan

构造器概要

构造器
构造器和说明

ClientConfig()

构造器
构造器和说明
`ClientConfig()`

方法概要

方法
限定符和类型	方法和说明
`protected void`	`addShutdownHook(IRegistry registry, RpcMonitor monitor, HeartBeatManager<T> heartBeatManager)` 添加关闭钩子
`protected org.apache.commons.pool.impl.GenericKeyedObjectPool<ServerNode,T>`	`bulidClientPool(ClassLoader classLoader, Class<?> ifaceClass)` 构建client对象池
`void`	`check()` 检查配置配置非法时，抛出异常`RpcException`
`T`	`createProxy(RegistryConfig registryConfig)` 创建代理
`void`	`destory()` 销毁资源包括：释放注册中心连接、heartbeat等资源。
`protected String`	`genConfigJson()` 生成配置文件的json格式
`String`	`getAddress()` getter method
`int`	`getHeartbeat()` getter method
`int`	`getHeartbeatInterval()` getter method
`int`	`getHeartbeatTimeout()` getter method
`int`	`getHeartbeatTimes()` getter method
`String`	`getIface()` getter method
`int`	`getInterval()` getter method
`String`	`getLoadbalance()` getter method
`int`	`getMaxActive()` getter method
`int`	`getMaxIdle()` getter method
`int`	`getMaxWait()` getter method
`int`	`getMinIdle()` getter method
`String`	`getName()` getter method
`String`	`getOwner()` getter method
`String`	`getProtocol()` getter method
`int`	`getRetry()` getter method
`String`	`getService()` getter method
`int`	`getTimeBetweenEvictionRunsMillis()` getter method
`int`	`getTimeout()` getter method
`boolean`	`isMonitor()` getter method
`boolean`	`isTestWhileIdle()` getter method
`void`	`setAddress(String address)` setter method
`void`	`setHeartbeat(int heartbeat)` setter method
`void`	`setHeartbeatInterval(int heartbeatInterval)` setter method
`void`	`setHeartbeatTimeout(int heartbeatTimeout)` setter method
`void`	`setHeartbeatTimes(int heartbeatTimes)` setter method
`void`	`setIface(String iface)` setter method
`void`	`setInterval(int interval)` setter method
`void`	`setLoadbalance(String loadbalance)` setter method
`void`	`setMaxActive(int maxActive)` setter method
`void`	`setMaxIdle(int maxIdle)` setter method
`void`	`setMaxWait(int maxWait)` setter method
`void`	`setMinIdle(int minIdle)` setter method
`void`	`setMonitor(boolean monitor)` setter method
`void`	`setName(String name)` setter method
`void`	`setOwner(String owner)` setter method
`void`	`setProtocol(String protocol)` setter method
`void`	`setRetry(int retry)` setter method
`void`	`setService(String service)` setter method
`void`	`setTestWhileIdle(boolean testWhileIdle)` setter method
`void`	`setTimeBetweenEvictionRunsMillis(int timeBetweenEvictionRunsMillis)` setter method
`void`	`setTimeout(int timeout)` setter method

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - ClientConfig
```
public ClientConfig()
```
- 方法详细资料
  - createProxy
```
public T createProxy(RegistryConfig registryConfig)
              throws Exception
```
    创建代理
    
    参数:
    registryConfig -
    
    返回:
    {client代理}
    
    抛出:
    
    Exception
  - bulidClientPool
```
protected org.apache.commons.pool.impl.GenericKeyedObjectPool<ServerNode,T> bulidClientPool(ClassLoader classLoader,
                                                                                Class<?> ifaceClass)
                                                                                     throws ClassNotFoundException,
                                                                                            InstantiationException,
                                                                                            IllegalAccessException
```
    构建client对象池
    
    参数:
    classLoader -
    ifaceClass -
    
    抛出:
    
    ClassNotFoundException
    
    InstantiationException
    
    IllegalAccessException
  - check
```
public void check()
           throws RpcException
```
    从接口复制的说明: IConfigCheck
    
    检查配置
    配置非法时，抛出异常RpcException
    
    指定者:
    
    check 在接口中 IConfigCheck
    
    抛出:
    
    RpcException
  - destory
```
public void destory()
```
    销毁资源
    包括：释放注册中心连接、heartbeat等资源。
  - genConfigJson
```
protected String genConfigJson()
```
    生成配置文件的json格式
    
    返回:
    配置的json格式
  - addShutdownHook
```
protected void addShutdownHook(IRegistry registry,
                   RpcMonitor monitor,
                   HeartBeatManager<T> heartBeatManager)
```
    添加关闭钩子
    
    参数:
    registry -
    monitor -
    heartBeatManager -
  - getName
```
public String getName()
```
    getter method
    
    返回:
    the name
    另请参阅:
    name
  - setName
```
public void setName(String name)
```
    setter method
    
    参数:
    name - the name to set
    另请参阅:
    name
  - getOwner
```
public String getOwner()
```
    getter method
    
    返回:
    the owner
    另请参阅:
    owner
  - setOwner
```
public void setOwner(String owner)
```
    setter method
    
    参数:
    owner - the owner to set
    另请参阅:
    owner
  - getService
```
public String getService()
```
    getter method
    
    返回:
    the service
    另请参阅:
    service
  - setService
```
public void setService(String service)
```
    setter method
    
    参数:
    service - the service to set
    另请参阅:
    service
  - getAddress
```
public String getAddress()
```
    getter method
    
    返回:
    the address
    另请参阅:
    address
  - setAddress
```
public void setAddress(String address)
```
    setter method
    
    参数:
    address - the address to set
    另请参阅:
    address
  - getRetry
```
public int getRetry()
```
    getter method
    
    返回:
    the retry
    另请参阅:
    retry
  - setRetry
```
public void setRetry(int retry)
```
    setter method
    
    参数:
    retry - the retry to set
    另请参阅:
    retry
  - getIface
```
public String getIface()
```
    getter method
    
    返回:
    the iface
    另请参阅:
    iface
  - setIface
```
public void setIface(String iface)
```
    setter method
    
    参数:
    iface - the iface to set
    另请参阅:
    iface
  - getProtocol
```
public String getProtocol()
```
    getter method
    
    返回:
    the protocol
    另请参阅:
    protocol
  - setProtocol
```
public void setProtocol(String protocol)
```
    setter method
    
    参数:
    protocol - the protocol to set
    另请参阅:
    protocol
  - isMonitor
```
public boolean isMonitor()
```
    getter method
    
    返回:
    the monitor
    另请参阅:
    monitor
  - setMonitor
```
public void setMonitor(boolean monitor)
```
    setter method
    
    参数:
    monitor - the monitor to set
    另请参阅:
    monitor
  - getInterval
```
public int getInterval()
```
    getter method
    
    返回:
    the interval
    另请参阅:
    interval
  - setInterval
```
public void setInterval(int interval)
```
    setter method
    
    参数:
    interval - the interval to set
    另请参阅:
    interval
  - getLoadbalance
```
public String getLoadbalance()
```
    getter method
    
    返回:
    the loadbalance
    另请参阅:
    loadbalance
  - setLoadbalance
```
public void setLoadbalance(String loadbalance)
```
    setter method
    
    参数:
    loadbalance - the loadbalance to set
    另请参阅:
    loadbalance
  - getTimeout
```
public int getTimeout()
```
    getter method
    
    返回:
    the timeout
    另请参阅:
    timeout
  - setTimeout
```
public void setTimeout(int timeout)
```
    setter method
    
    参数:
    timeout - the timeout to set
    另请参阅:
    timeout
  - getMaxActive
```
public int getMaxActive()
```
    getter method
    
    返回:
    the maxActive
    另请参阅:
    maxActive
  - setMaxActive
```
public void setMaxActive(int maxActive)
```
    setter method
    
    参数:
    maxActive - the maxActive to set
    另请参阅:
    maxActive
  - getMaxIdle
```
public int getMaxIdle()
```
    getter method
    
    返回:
    the maxIdle
    另请参阅:
    maxIdle
  - setMaxIdle
```
public void setMaxIdle(int maxIdle)
```
    setter method
    
    参数:
    maxIdle - the maxIdle to set
    另请参阅:
    maxIdle
  - getMinIdle
```
public int getMinIdle()
```
    getter method
    
    返回:
    the minIdle
    另请参阅:
    minIdle
  - setMinIdle
```
public void setMinIdle(int minIdle)
```
    setter method
    
    参数:
    minIdle - the minIdle to set
    另请参阅:
    minIdle
  - getMaxWait
```
public int getMaxWait()
```
    getter method
    
    返回:
    the maxWait
    另请参阅:
    maxWait
  - setMaxWait
```
public void setMaxWait(int maxWait)
```
    setter method
    
    参数:
    maxWait - the maxWait to set
    另请参阅:
    maxWait
  - getTimeBetweenEvictionRunsMillis
```
public int getTimeBetweenEvictionRunsMillis()
```
    getter method
    
    返回:
    the timeBetweenEvictionRunsMillis
    另请参阅:
    timeBetweenEvictionRunsMillis
  - setTimeBetweenEvictionRunsMillis
```
public void setTimeBetweenEvictionRunsMillis(int timeBetweenEvictionRunsMillis)
```
    setter method
    
    参数:
    timeBetweenEvictionRunsMillis - the timeBetweenEvictionRunsMillis to set
    另请参阅:
    timeBetweenEvictionRunsMillis
  - isTestWhileIdle
```
public boolean isTestWhileIdle()
```
    getter method
    
    返回:
    the testWhileIdle
    另请参阅:
    testWhileIdle
  - setTestWhileIdle
```
public void setTestWhileIdle(boolean testWhileIdle)
```
    setter method
    
    参数:
    testWhileIdle - the testWhileIdle to set
    另请参阅:
    testWhileIdle
  - getHeartbeat
```
public int getHeartbeat()
```
    getter method
    
    返回:
    the heartbeat
    另请参阅:
    heartbeat
  - setHeartbeat
```
public void setHeartbeat(int heartbeat)
```
    setter method
    
    参数:
    heartbeat - the heartbeat to set
    另请参阅:
    heartbeat
  - getHeartbeatTimeout
```
public int getHeartbeatTimeout()
```
    getter method
    
    返回:
    the heartbeatTimeout
    另请参阅:
    heartbeatTimeout
  - setHeartbeatTimeout
```
public void setHeartbeatTimeout(int heartbeatTimeout)
```
    setter method
    
    参数:
    heartbeatTimeout - the heartbeatTimeout to set
    另请参阅:
    heartbeatTimeout
  - getHeartbeatTimes
```
public int getHeartbeatTimes()
```
    getter method
    
    返回:
    the heartbeatTimes
    另请参阅:
    heartbeatTimes
  - setHeartbeatTimes
```
public void setHeartbeatTimes(int heartbeatTimes)
```
    setter method
    
    参数:
    heartbeatTimes - the heartbeatTimes to set
    另请参阅:
    heartbeatTimes
  - getHeartbeatInterval
```
public int getHeartbeatInterval()
```
    getter method
    
    返回:
    the heartbeatInterval
    另请参阅:
    heartbeatInterval
  - setHeartbeatInterval
```
public void setHeartbeatInterval(int heartbeatInterval)
```
    setter method
    
    参数:
    heartbeatInterval - the heartbeatInterval to set
    另请参阅:
    heartbeatInterval

类 ClientConfig<T>

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

ClientConfig

方法详细资料

createProxy

bulidClientPool

check

destory

genConfigJson

addShutdownHook

getName

setName

getOwner

setOwner

getService

setService

getAddress

setAddress

getRetry

setRetry

getIface

setIface

getProtocol

setProtocol

isMonitor

setMonitor

getInterval

setInterval

getLoadbalance

setLoadbalance

getTimeout

setTimeout

getMaxActive

setMaxActive

getMaxIdle

setMaxIdle

getMinIdle

setMinIdle

getMaxWait

setMaxWait

getTimeBetweenEvictionRunsMillis

setTimeBetweenEvictionRunsMillis

isTestWhileIdle

setTestWhileIdle

getHeartbeat

setHeartbeat

getHeartbeatTimeout

setHeartbeatTimeout

getHeartbeatTimes

setHeartbeatTimes

getHeartbeatInterval

setHeartbeatInterval