com.alibaba.otter.canal.client

接口 CanalMQConnector

所有超级接口:

CanalConnector

所有已知实现类:

KafkaCanalConnector, KafkaOffsetCanalConnector, RabbitMQCanalConnector, RocketMQCanalConnector

public interface CanalMQConnector
extends CanalConnector

canal MQ数据操作客户端

 1. canal server写入MQ消息，考虑性能会合并多条数据写入为一个MQ消息，一个Message对应一个MQ消息
 2. canal client消费MQ消息，因为client性能会弱于server的写入，MQ数据获取时会拿到堆积的多条MQ消息，会拿到List
 3. client的ack/rollback，都是和MQ直接交互，不存在对应的batchId概念
 

从以下版本开始:

1.1.1

作者:

agapple 2018年10月28日 下午6:42:27

方法概要

限定符和类型	方法和说明
void	ack() 消费确认。
java.util.List<FlatMessage>	getFlatList(java.lang.Long timeout, java.util.concurrent.TimeUnit unit) 获取数据，自动进行确认，设置timeout时间直到拿到数据为止 该方法返回的条件： a.
java.util.List<FlatMessage>	getFlatListWithoutAck(java.lang.Long timeout, java.util.concurrent.TimeUnit unit) 获取数据，设置timeout时间直到拿到数据为止 该方法返回的条件： a.
java.util.List<Message>	getList(java.lang.Long timeout, java.util.concurrent.TimeUnit unit) 获取数据，自动进行确认，设置timeout时间直到拿到数据为止 该方法返回的条件： a.
java.util.List<Message>	getListWithoutAck(java.lang.Long timeout, java.util.concurrent.TimeUnit unit) 获取数据，设置timeout时间直到拿到数据为止 该方法返回的条件： a.
void	rollback() 回滚到未进行 ack() 的地方，下次fetch的时候，可以从最后一个没有 ack() 的地方开始拿

从接口继承的方法 com.alibaba.otter.canal.client.CanalConnector

ack, checkValid, connect, disconnect, get, get, getWithoutAck, getWithoutAck, rollback, subscribe, subscribe, unsubscribe

方法详细资料

getList

java.util.List<Message> getList(java.lang.Long timeout,
                                java.util.concurrent.TimeUnit unit)
                         throws CanalClientException

获取数据，自动进行确认，设置timeout时间直到拿到数据为止

 该方法返回的条件：
  a. 如果timeout=0，有多少取多少，不会阻塞等待
  b. 如果timeout不为0，尝试阻塞对应的超时时间，直到拿到数据就返回
 

返回:

抛出:

CanalClientException

getListWithoutAck

java.util.List<Message> getListWithoutAck(java.lang.Long timeout,
                                          java.util.concurrent.TimeUnit unit)
                                   throws CanalClientException

获取数据，设置timeout时间直到拿到数据为止

 该方法返回的条件：
  a. 如果timeout=0，有多少取多少，不会阻塞等待
  b. 如果timeout不为0，尝试阻塞对应的超时时间，直到拿到数据就返回
 

抛出:

CanalClientException

getFlatList

java.util.List<FlatMessage> getFlatList(java.lang.Long timeout,
                                        java.util.concurrent.TimeUnit unit)
                                 throws CanalClientException

获取数据，自动进行确认，设置timeout时间直到拿到数据为止

 该方法返回的条件：
  a. 如果timeout=0，有多少取多少，不会阻塞等待
  b. 如果timeout不为0，尝试阻塞对应的超时时间，直到拿到数据就返回
 

返回:

抛出:

CanalClientException

getFlatListWithoutAck

java.util.List<FlatMessage> getFlatListWithoutAck(java.lang.Long timeout,
                                                  java.util.concurrent.TimeUnit unit)
                                           throws CanalClientException

获取数据，设置timeout时间直到拿到数据为止

 该方法返回的条件：
  a. 如果timeout=0，有多少取多少，不会阻塞等待
  b. 如果timeout不为0，尝试阻塞对应的超时时间，直到拿到数据就返回
 

抛出:

CanalClientException

ack

void ack()
  throws CanalClientException

消费确认。

抛出:

CanalClientException

rollback

void rollback()
       throws CanalClientException

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

指定者:

rollback 在接口中 CanalConnector

抛出:

CanalClientException