com.alibaba.otter.canal.client

接口 CanalConnector

所有已知子接口:

CanalMQConnector

所有已知实现类:

ClusterCanalConnector, KafkaCanalConnector, KafkaOffsetCanalConnector, RabbitMQCanalConnector, RocketMQCanalConnector, SimpleCanalConnector

public interface CanalConnector

canal数据操作客户端

版本:

1.0.0

作者:

zebin.xuzb @ 2012-6-19, jianghang

方法概要

限定符和类型	方法和说明
void	ack(long batchId) 进行 batch id 的确认。
boolean	checkValid() 检查下链接是否合法 几种case下链接不合法: 1.
void	connect() 链接对应的canal server
void	disconnect() 释放链接
Message	get(int batchSize) 获取数据，自动进行确认，该方法返回的条件：尝试拿batchSize条记录，有多少取多少，不会阻塞等待
Message	get(int batchSize, java.lang.Long timeout, java.util.concurrent.TimeUnit unit) 获取数据，自动进行确认 该方法返回的条件： a.
Message	getWithoutAck(int batchSize) 不指定 position 获取事件，该方法返回的条件: 尝试拿batchSize条记录，有多少取多少，不会阻塞等待 canal 会记住此 client 最新的position。
Message	getWithoutAck(int batchSize, java.lang.Long timeout, java.util.concurrent.TimeUnit unit) 不指定 position 获取事件.
void	rollback() 回滚到未进行 ack(long) 的地方，下次fetch的时候，可以从最后一个没有 ack(long) 的地方开始拿
void	rollback(long batchId) 回滚到未进行 ack(long) 的地方，指定回滚具体的batchId
void	subscribe() 客户端订阅，不提交客户端filter，以服务端的filter为准
void	subscribe(java.lang.String filter) 客户端订阅，重复订阅时会更新对应的filter信息 说明： a.
void	unsubscribe() 取消订阅

方法详细资料

connect

void connect()
      throws CanalClientException

链接对应的canal server

抛出:

CanalClientException

disconnect

void disconnect()
         throws CanalClientException

释放链接

抛出:

CanalClientException

checkValid

boolean checkValid()
            throws CanalClientException

检查下链接是否合法

 几种case下链接不合法:
 1. 链接canal server失败，一直没有一个可用的链接，返回false
 2. 当前客户端在进行running抢占的时候，做为备份节点存在，非处于工作节点，返回false
 
 说明：
 a. 当前客户端一旦做为备份节点存在，当前所有的对CanalConnector的操作都会处于阻塞状态，直到转为工作节点
 b. 所以业务方最好定时调用checkValid()方法用，比如调用CanalConnector所在线程的interrupt，直接退出CanalConnector，并根据自己的需要退出自己的资源
 

抛出:

CanalClientException

subscribe

void subscribe(java.lang.String filter)
        throws CanalClientException

客户端订阅，重复订阅时会更新对应的filter信息

 说明：
 a. 如果本次订阅中filter信息为空，则直接使用canal server服务端配置的filter信息
 b. 如果本次订阅中filter信息不为空，目前会直接替换canal server服务端配置的filter信息，以本次提交的为准
 
 TODO: 后续可以考虑，如果本次提交的filter不为空，在执行过滤时，是对canal server filter + 本次filter的交集处理，达到只取1份binlog数据，多个客户端消费不同的表
 

抛出:

CanalClientException

subscribe

void subscribe()
        throws CanalClientException

客户端订阅，不提交客户端filter，以服务端的filter为准

抛出:

CanalClientException

unsubscribe

void unsubscribe()
          throws CanalClientException

取消订阅

抛出:

CanalClientException

get

Message get(int batchSize)
     throws CanalClientException

获取数据，自动进行确认，该方法返回的条件：尝试拿batchSize条记录，有多少取多少，不会阻塞等待

参数:

batchSize -

返回:

抛出:

CanalClientException

get

Message get(int batchSize,
            java.lang.Long timeout,
            java.util.concurrent.TimeUnit unit)
     throws CanalClientException

获取数据，自动进行确认

 该方法返回的条件：
  a. 拿够batchSize条记录或者超过timeout时间
  b. 如果timeout=0，则阻塞至拿到batchSize记录才返回
 

参数:

batchSize -

返回:

抛出:

CanalClientException

getWithoutAck

Message getWithoutAck(int batchSize)
               throws CanalClientException

不指定 position 获取事件，该方法返回的条件: 尝试拿batchSize条记录，有多少取多少，不会阻塞等待
canal 会记住此 client 最新的position。
如果是第一次 fetch，则会从 canal 中保存的最老一条数据开始输出。

参数:

batchSize -

抛出:

CanalClientException

getWithoutAck

Message getWithoutAck(int batchSize,
                      java.lang.Long timeout,
                      java.util.concurrent.TimeUnit unit)
               throws CanalClientException

不指定 position 获取事件.

 该方法返回的条件：
  a. 拿够batchSize条记录或者超过timeout时间
  b. 如果timeout=0，则阻塞至拿到batchSize记录才返回
 

canal 会记住此 client 最新的position。
如果是第一次 fetch，则会从 canal 中保存的最老一条数据开始输出。

参数:

batchSize -

timeout -

unit -

返回:

抛出:

CanalClientException

ack

void ack(long batchId)
  throws CanalClientException

进行 batch id 的确认。确认之后，小于等于此 batchId 的 Message 都会被确认。

参数:

batchId -

抛出:

CanalClientException

rollback

void rollback(long batchId)
       throws CanalClientException

回滚到未进行 ack(long) 的地方，指定回滚具体的batchId

抛出:

CanalClientException

rollback

void rollback()
       throws CanalClientException

回滚到未进行 ack(long) 的地方，下次fetch的时候，可以从最后一个没有 ack(long) 的地方开始拿

抛出:

CanalClientException