ClientImpl (service-api 3.40.0SP12 API)

java.lang.Object
- java.lang.Thread
- - com.tencent.tcaplus.client.impl.ClientImpl

All Implemented Interfaces:: Client, Runnable

public class ClientImpl
extends Thread
implements Client

Nested Class Summary
- Nested classes/interfaces inherited from class java.lang.Thread
  Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields
Modifier and Type Field and Description

protected static org.slf4j.Logger LOGGER

static String version
- Fields inherited from class java.lang.Thread
  MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Fields
Modifier and Type	Field and Description
`protected static org.slf4j.Logger`	`LOGGER`
`static String`	`version`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Request`	`acquireRequest()` 获得一个请求对象
`static Client`	`create(int appId, int zoneId, String signature, List<String> addresses, int callbackPoolSize, int timeout)`
`static void`	`destroy(Client client)`
`GenericTableTraverser`	`getGenericTableTraverser()` 获取generic表的遍历器,需要调用`Traverser.setTableName(String)`设置表名
`GenericTableTraverser`	`getGenericTableTraverser(String tableName)` 获取generic表的遍历器
`ListTableTraverser`	`getListTableTraverser()` 获取list表的遍历器,需要调用`Traverser.setTableName(String)`设置表名
`ListTableTraverser`	`getListTableTraverser(String tableName)` 获取list表的遍历器
`String`	`getVersion()` 获得api版本号
`void`	`init(int appId, int zoneId, String signature, List<String> addresses, int callbackPoolSize, int timeout)` 初始化函数
`Response`	`poll(Request req)` 同步访问方法
`void`	`post(Request req, Future future)` 异步访问方法
`void`	`run()` 主循环线程
`void`	`shutdown()` 停止主逻辑线程
`String`	`toString()`

Methods inherited from class java.lang.Thread
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, yield

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

version
```
public static String version
```

LOGGER

protected static final org.slf4j.Logger LOGGER

Method Detail

create

public static Client create(int appId,
                            int zoneId,
                            String signature,
                            List<String> addresses,
                            int callbackPoolSize,
                            int timeout)

init
```
public void init(int appId,
                 int zoneId,
                 String signature,
                 List<String> addresses,
                 int callbackPoolSize,
                 int timeout)
          throws TCaplusException
```
初始化函数

Parameters:

appId - 在网站注册相应服务以后，你可以得到该appId

zoneId - 业务所属的区服ID

signature - 签名/密码，在网站注册相应服务以后，你可以得到该字符串

addresses - dir server 地址列表

callbackPoolSize - 异步回调线程池数量

timeout - 初始化proxy连接超时时间，必须大于0，单位ms

Throws:

TCaplusException

run
```
public void run()
```
主循环线程

Specified by:

run in interface Runnable

Overrides:

run in class Thread

acquireRequest
```
public Request acquireRequest()
```
Description copied from interface: Client

获得一个请求对象

Specified by:

acquireRequest in interface Client

Returns:

返回Request接口对象

poll

public Response poll(Request req)
              throws TCaplusException

Description copied from interface: Client

同步访问方法

 
 List<String> dirAddr = new ArrayList<String>;
 dirAddr.add("tcp://10.0.0.1:9999");

 //创建client实例
 Client client = ClientFactory.createClient(1, 1, "47CCA171EB3A288A", dirAddr);

 //获得一个请求对象
 Request req = client.acquireRequest();

 //设置命令字、表名、要查询的value字段等信息
 req.setCmd(TcaplusProtocolCsConstants.TCAPLUS_CMD_GET_REQ);
 req.setTableName(TABLE_NAME);
 req.addFieldName("value_name");

 //设置key字段信息
 Record record = req.addRecord();
 record.setKeyInt("key_name", 1);

 //执行阻塞调用
 Response rsp = client.poll(req);
 if (rsp.getResult() == TCapErrCode.GEN_ERR_SUC){
     Record record = rsp.fetchRecord();
     System.out.println(record.getValueInt("value_name"));
 }

 //销毁访问实例
 ClientFactory.destroyClient(client);

Specified by:: poll in interface Client
Parameters:: req - 请求对象
Returns:: 响应消息对象
Throws:: TCaplusException

post

public void post(Request req,
                 Future future)
          throws TCaplusException

Description copied from interface: Client

异步访问方法

例子：

 
 List<String> dirAddr = new ArrayList<String>;
 dirAddr.add("tcp://10.0.0.1:9999");

 //创建client实例
 Client client = ClientFactory.createClient(1, 1, "47CCA171EB3A288A", dirAddr);

 //获得一个请求对象
 Request req = client.acquireRequest();

 //设置命令字、表名、要查询的value字段等信息
 req.setCmd(TcaplusProtocolCsConstants.TCAPLUS_CMD_GET_REQ);
 req.setTableName(TABLE_NAME);
 req.addFieldName("value_name");

 //设置key字段信息
 Record record = req.addRecord();
 record.setKeyInt("key_name", 1);

 //执行异步调用接口
 client.post(req, new Future() {
     public void onResponse(Response res) {
         if (rsp.getResult() == TCapErrCode.GEN_ERR_SUC) {
             Record record = rsp.fetchRecord();
             System.out.println(record.getValueInt("value_name"));
         }
     }
 });

 //等待异步回调完成
 Thread.sleep(1000);

 //销毁访问实例
 ClientFactory.destroyClient(client);

Specified by:: post in interface Client
Parameters:: req - 请求对象; future - 异步回调对象
Throws:: TCaplusException

shutdown
```
public void shutdown()
```
停止主逻辑线程

getGenericTableTraverser
```
public GenericTableTraverser getGenericTableTraverser(String tableName)
```
Description copied from interface: Client

获取generic表的遍历器

Specified by:

getGenericTableTraverser in interface Client

Parameters:

tableName - 需要遍历的表的tableName

Returns:

generic表遍历器

getGenericTableTraverser
```
public GenericTableTraverser getGenericTableTraverser()
```
Description copied from interface: Client

获取generic表的遍历器,需要调用Traverser.setTableName(String)设置表名

Specified by:

getGenericTableTraverser in interface Client

Returns:

generic表遍历器

getListTableTraverser
```
public ListTableTraverser getListTableTraverser(String tableName)
```
Description copied from interface: Client

获取list表的遍历器

Specified by:

getListTableTraverser in interface Client

Parameters:

tableName - 需要遍历的表的tableName

Returns:

list表遍历器

getListTableTraverser
```
public ListTableTraverser getListTableTraverser()
```
Description copied from interface: Client

获取list表的遍历器,需要调用Traverser.setTableName(String)设置表名

Specified by:

getListTableTraverser in interface Client

Returns:

list表遍历器

getVersion
```
public String getVersion()
```
Description copied from interface: Client

获得api版本号

Specified by:

getVersion in interface Client

Returns:

返回版本号

destroy

public static void destroy(Client client)

toString
```
public String toString()
```
Overrides:

toString in class Thread

Class ClientImpl

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Field Summary

Fields inherited from class java.lang.Thread

Method Summary

Methods inherited from class java.lang.Thread

Methods inherited from class java.lang.Object

Field Detail

version

LOGGER

Method Detail

create

init

run

acquireRequest

poll

post

shutdown

getGenericTableTraverser

getGenericTableTraverser

getListTableTraverser

getListTableTraverser

getVersion

destroy

toString