com.alibaba.otter.canal.client.impl

类 SimpleCanalConnector

java.lang.Object

com.alibaba.otter.canal.client.impl.SimpleCanalConnector

所有已实现的接口:

CanalConnector

public class SimpleCanalConnector
extends java.lang.Object
implements CanalConnector

基于CanalServerWithNetty定义的网络协议接口，对于canal数据进行get/rollback/ack等操作

版本:

1.0.0

作者:

jianghang 2012-10-24 下午05:37:20

构造器概要

构造器

构造器和说明
SimpleCanalConnector(java.net.SocketAddress address, java.lang.String username, java.lang.String password, java.lang.String destination)
SimpleCanalConnector(java.net.SocketAddress address, java.lang.String username, java.lang.String password, java.lang.String destination, int soTimeout)
SimpleCanalConnector(java.net.SocketAddress address, java.lang.String username, java.lang.String password, java.lang.String destination, int soTimeout, int idleTimeout)

方法概要

方法

限定符和类型	方法和说明
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.
java.net.SocketAddress	getAddress()
int	getIdleTimeout()
java.net.SocketAddress	getNextAddress()
java.lang.String	getPassword()
int	getSoTimeout()
java.lang.String	getUsername()
Message	getWithoutAck(int batchSize) 不指定 position 获取事件，该方法返回的条件: 尝试拿batchSize条记录，有多少取多少，不会阻塞等待 canal 会记住此 client 最新的position。
Message	getWithoutAck(int batchSize, java.lang.Long timeout, java.util.concurrent.TimeUnit unit) 不指定 position 获取事件.
boolean	isLazyParseEntry()
void	rollback() 回滚到未进行 CanalConnector.ack(long) 的地方，下次fetch的时候，可以从最后一个没有 CanalConnector.ack(long) 的地方开始拿
void	rollback(long batchId) 回滚到未进行 CanalConnector.ack(long) 的地方，指定回滚具体的batchId
void	setFilter(java.lang.String filter)
void	setIdleTimeout(int idleTimeout)
void	setLazyParseEntry(boolean lazyParseEntry)
void	setRollbackOnConnect(boolean rollbackOnConnect)
void	setRollbackOnDisConnect(boolean rollbackOnDisConnect)
void	setSoTimeout(int soTimeout)
void	setZkClientx(ZkClientx zkClientx)
void	stopRunning() 中断的阻塞，用于优雅停止client
void	subscribe() 客户端订阅，不提交客户端filter，以服务端的filter为准
void	subscribe(java.lang.String filter) 客户端订阅，重复订阅时会更新对应的filter信息 说明： a.
void	unsubscribe() 取消订阅

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

SimpleCanalConnector

public SimpleCanalConnector(java.net.SocketAddress address,
                    java.lang.String username,
                    java.lang.String password,
                    java.lang.String destination)

SimpleCanalConnector

public SimpleCanalConnector(java.net.SocketAddress address,
                    java.lang.String username,
                    java.lang.String password,
                    java.lang.String destination,
                    int soTimeout)

SimpleCanalConnector

public SimpleCanalConnector(java.net.SocketAddress address,
                    java.lang.String username,
                    java.lang.String password,
                    java.lang.String destination,
                    int soTimeout,
                    int idleTimeout)

方法详细资料

connect

public void connect()
             throws CanalClientException

从接口复制的说明: CanalConnector

链接对应的canal server

指定者:

connect 在接口中 CanalConnector

抛出:

CanalClientException

disconnect

public void disconnect()
                throws CanalClientException

从接口复制的说明: CanalConnector

释放链接

指定者:

disconnect 在接口中 CanalConnector

抛出:

CanalClientException

subscribe

public void subscribe()
               throws CanalClientException

从接口复制的说明: CanalConnector

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

指定者:

subscribe 在接口中 CanalConnector

抛出:

CanalClientException

subscribe

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

从接口复制的说明: CanalConnector

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

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

指定者:

subscribe 在接口中 CanalConnector

抛出:

CanalClientException

unsubscribe

public void unsubscribe()
                 throws CanalClientException

从接口复制的说明: CanalConnector

取消订阅

指定者:

unsubscribe 在接口中 CanalConnector

抛出:

CanalClientException

get

public Message get(int batchSize)
            throws CanalClientException

从接口复制的说明: CanalConnector

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

指定者:

get 在接口中 CanalConnector

返回:

抛出:

CanalClientException

get

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

从接口复制的说明: CanalConnector

获取数据，自动进行确认

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

指定者:

get 在接口中 CanalConnector

返回:

抛出:

CanalClientException

getWithoutAck

public Message getWithoutAck(int batchSize)
                      throws CanalClientException

从接口复制的说明: CanalConnector

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

指定者:

getWithoutAck 在接口中 CanalConnector

抛出:

CanalClientException

getWithoutAck

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

从接口复制的说明: CanalConnector

不指定 position 获取事件.

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

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

指定者:

getWithoutAck 在接口中 CanalConnector

返回:

抛出:

CanalClientException

ack

public void ack(long batchId)
         throws CanalClientException

从接口复制的说明: CanalConnector

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

指定者:

ack 在接口中 CanalConnector

抛出:

CanalClientException

rollback

public void rollback(long batchId)
              throws CanalClientException

从接口复制的说明: CanalConnector

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

指定者:

rollback 在接口中 CanalConnector

抛出:

CanalClientException

rollback

public void rollback()
              throws CanalClientException

从接口复制的说明: CanalConnector

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

指定者:

rollback 在接口中 CanalConnector

抛出:

CanalClientException

checkValid

public boolean checkValid()

从接口复制的说明: CanalConnector

检查下链接是否合法

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

指定者:

checkValid 在接口中 CanalConnector

getNextAddress

public java.net.SocketAddress getNextAddress()

getAddress

public java.net.SocketAddress getAddress()

getUsername

public java.lang.String getUsername()

getPassword

public java.lang.String getPassword()

getSoTimeout

public int getSoTimeout()

setSoTimeout

public void setSoTimeout(int soTimeout)

getIdleTimeout

public int getIdleTimeout()

setIdleTimeout

public void setIdleTimeout(int idleTimeout)

setZkClientx

public void setZkClientx(ZkClientx zkClientx)

setRollbackOnConnect

public void setRollbackOnConnect(boolean rollbackOnConnect)

setRollbackOnDisConnect

public void setRollbackOnDisConnect(boolean rollbackOnDisConnect)

setFilter

public void setFilter(java.lang.String filter)

isLazyParseEntry

public boolean isLazyParseEntry()

setLazyParseEntry

public void setLazyParseEntry(boolean lazyParseEntry)

stopRunning

public void stopRunning()

从接口复制的说明: CanalConnector

中断的阻塞，用于优雅停止client

指定者:

stopRunning 在接口中 CanalConnector