com.tencent.tcaplus.client

Interface Client

All Known Implementing Classes:

ClientImpl

public interface Client

Tcaplus api客户端接口

Version:

version 1.0

Author:

yahuiwang, elviszhu

Method Summary

Modifier and Type	Method and Description
Request	acquireRequest() 获得一个请求对象
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版本号
Response	poll(Request req) 同步访问方法
void	post(Request req, Future future) 异步访问方法

Method Detail

acquireRequest

Request acquireRequest()

获得一个请求对象

Returns:

返回Request接口对象

post

void post(Request req,
          Future future)
   throws TCaplusException

异步访问方法

例子：

 
 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);
 
 

Parameters:

req - 请求对象

future - 异步回调对象

Throws:

TCaplusException

poll

Response poll(Request req)
       throws TCaplusException

同步访问方法

 
 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);
 
 

Parameters:

req - 请求对象

Returns:

响应消息对象

Throws:

TCaplusException

getGenericTableTraverser

GenericTableTraverser getGenericTableTraverser(String tableName)

获取generic表的遍历器

Parameters:

tableName - 需要遍历的表的tableName

Returns:

generic表遍历器

getGenericTableTraverser

GenericTableTraverser getGenericTableTraverser()

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

Returns:

generic表遍历器

getListTableTraverser

ListTableTraverser getListTableTraverser(String tableName)

获取list表的遍历器

Parameters:

tableName - 需要遍历的表的tableName

Returns:

list表遍历器

getListTableTraverser

ListTableTraverser getListTableTraverser()

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

Returns:

list表遍历器

getVersion

String getVersion()

获得api版本号

Returns:

返回版本号