org.noear.folkmq.client

类 MqClientDefault

java.lang.Object

org.noear.folkmq.client.MqClientDefault

所有已实现的接口:

MqClient, MqClientInternal

public class MqClientDefault
extends Object
implements MqClientInternal

消息客户端默认实现

从以下版本开始:

1.0, 1.2

作者:

noear

字段概要

字段

限定符和类型	字段和说明
protected boolean	autoAcknowledge
protected ExecutorService	consumeExecutor
protected MqConsumeHandler	listenHandler
protected MqTransactionCheckback	transactionCheckback

构造器概要

构造器

构造器和说明
MqClientDefault(String[] urls)
MqClientDefault(String[] urls, MqClientListener clientListener)

方法概要

限定符和类型	方法和说明
boolean	autoAcknowledge() 自动回执
MqClient	autoAcknowledge(boolean auto) 自动回执
CompletableFuture<String>	call(String apiName, String apiToken, String topic, String consumerGroup) 接口调用
MqClient	config(org.noear.socketd.transport.client.ClientConfigHandler configHandler) 客户端配置
MqClient	connect() 连接
MqClient	consumeExecutor(ExecutorService consumeExecutor) 消费执行器
void	disconnect() 断开连接
protected String	diversionOrNull(String fullTopic, MqMessage message)
protected MqSubscription	getSubscription(String fullTopic, String consumerGroup)
protected Collection<MqSubscription>	getSubscriptionAll()
protected int	getSubscriptionSize()
void	listen(MqConsumeHandler listenHandler) 监听
String	name() 名字（即，默认消费者组）
MqClient	nameAs(String name) 名字取为（即，默认消费者组）
String	namespace() 命名空间
MqClient	namespaceAs(String namespace) 命名空间
MqTransaction	newTransaction() 创建事务
void	publish(String topic, MqMessage message) 同步发布消息
void	publish2(String tmid, List<String> keyAry, boolean isRollback) 发布二次提交
CompletableFuture<Boolean>	publishAsync(String topic, MqMessage message) 发布消息
void	reply(org.noear.socketd.transport.core.Session session, org.noear.socketd.transport.core.Message from, MqMessageReceivedImpl message, boolean isOk, org.noear.socketd.transport.core.Entity entity) 消费答复
org.noear.socketd.transport.stream.RequestStream	send(MqMessage message, String toName, long timeout) 发送
void	subscribe(String topic, String consumerGroup, boolean autoAck, MqConsumeHandler consumerHandler) 订阅主题
MqClient	transactionCheckback(MqTransactionCheckback transactionCheckback) 事务回查
void	unpublish(String topic, String key) 取消发布
CompletableFuture<Boolean>	unpublishAsync(String topic, String key) 取消发布
void	unsubscribe(String topic, String consumerGroup) 取消订阅主题

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

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

从接口继承的方法 org.noear.folkmq.client.MqClient

send, subscribe, subscribe, unsubscribe

字段详细资料

transactionCheckback

protected MqTransactionCheckback transactionCheckback

listenHandler

protected MqConsumeHandler listenHandler

consumeExecutor

protected ExecutorService consumeExecutor

autoAcknowledge

protected boolean autoAcknowledge

构造器详细资料

MqClientDefault

public MqClientDefault(String[] urls)

MqClientDefault

public MqClientDefault(String[] urls,
                       MqClientListener clientListener)

方法详细资料

name

public String name()

从接口复制的说明: MqClient

名字（即，默认消费者组）

指定者:

name 在接口中 MqClient

nameAs

public MqClient nameAs(String name)

从接口复制的说明: MqClient

名字取为（即，默认消费者组）

指定者:

nameAs 在接口中 MqClient

namespace

public String namespace()

从接口复制的说明: MqClient

命名空间

指定者:

namespace 在接口中 MqClient

namespaceAs

public MqClient namespaceAs(String namespace)

从接口复制的说明: MqClient

命名空间

指定者:

namespaceAs 在接口中 MqClient

connect

public MqClient connect()
                 throws IOException

从接口复制的说明: MqClient

连接

指定者:

connect 在接口中 MqClient

抛出:

IOException

disconnect

public void disconnect()
                throws IOException

从接口复制的说明: MqClient

断开连接

指定者:

disconnect 在接口中 MqClient

抛出:

IOException

config

public MqClient config(org.noear.socketd.transport.client.ClientConfigHandler configHandler)

从接口复制的说明: MqClient

客户端配置

指定者:

config 在接口中 MqClient

consumeExecutor

public MqClient consumeExecutor(ExecutorService consumeExecutor)

从接口复制的说明: MqClient

消费执行器

指定者:

consumeExecutor 在接口中 MqClient

autoAcknowledge

public MqClient autoAcknowledge(boolean auto)

自动回执

指定者:

autoAcknowledge 在接口中 MqClient

参数:

auto - 自动（默认为 true）

autoAcknowledge

public boolean autoAcknowledge()

从接口复制的说明: MqClient

自动回执

指定者:

autoAcknowledge 在接口中 MqClient

call

public CompletableFuture<String> call(String apiName,
                                      String apiToken,
                                      String topic,
                                      String consumerGroup)
                               throws IOException

从接口复制的说明: MqClient

接口调用

指定者:

call 在接口中 MqClient

抛出:

IOException

subscribe

public void subscribe(String topic,
                      String consumerGroup,
                      boolean autoAck,
                      MqConsumeHandler consumerHandler)
               throws IOException

订阅主题

指定者:

subscribe 在接口中 MqClient

参数:

topic - 主题

consumerGroup - 消费者组

consumerHandler - 消费处理

autoAck - 是否自动回执

抛出:

IOException

unsubscribe

public void unsubscribe(String topic,
                        String consumerGroup)
                 throws IOException

从接口复制的说明: MqClient

取消订阅主题

指定者:

unsubscribe 在接口中 MqClient

参数:

topic - 主题

consumerGroup - 消费者组

抛出:

IOException

publish

public void publish(String topic,
                    MqMessage message)
             throws IOException

从接口复制的说明: MqClient

同步发布消息

指定者:

publish 在接口中 MqClient

参数:

topic - 主题

message - 消息

抛出:

IOException

publishAsync

public CompletableFuture<Boolean> publishAsync(String topic,
                                               MqMessage message)
                                        throws IOException

发布消息

指定者:

publishAsync 在接口中 MqClient

参数:

topic - 主题

message - 消息

抛出:

IOException

unpublish

public void unpublish(String topic,
                      String key)
               throws IOException

从接口复制的说明: MqClient

取消发布

指定者:

unpublish 在接口中 MqClient

参数:

topic - 主题

key - 消息主键

抛出:

IOException

unpublishAsync

public CompletableFuture<Boolean> unpublishAsync(String topic,
                                                 String key)
                                          throws IOException

从接口复制的说明: MqClient

取消发布

指定者:

unpublishAsync 在接口中 MqClient

参数:

topic - 主题

key - 消息主键

抛出:

IOException

listen

public void listen(MqConsumeHandler listenHandler)

从接口复制的说明: MqClient

监听

指定者:

listen 在接口中 MqClient

参数:

listenHandler - 监听处理

send

public org.noear.socketd.transport.stream.RequestStream send(MqMessage message,
                                                             String toName,
                                                             long timeout)
                                                      throws IOException

从接口复制的说明: MqClient

发送

指定者:

send 在接口中 MqClient

参数:

message - 消息

toName - 发送目标名字

timeout - 超时（单位毫秒）

抛出:

IOException

transactionCheckback

public MqClient transactionCheckback(MqTransactionCheckback transactionCheckback)

事务回查

指定者:

transactionCheckback 在接口中 MqClient

参数:

transactionCheckback - 事务回查处理

newTransaction

public MqTransaction newTransaction()

创建事务

指定者:

newTransaction 在接口中 MqClient

publish2

public void publish2(String tmid,
                     List<String> keyAry,
                     boolean isRollback)
              throws IOException

发布二次提交

指定者:

publish2 在接口中 MqClientInternal

参数:

tmid - 事务管理id

keyAry - 消息主键集合

isRollback - 是否回滚

抛出:

IOException

reply

public void reply(org.noear.socketd.transport.core.Session session,
                  org.noear.socketd.transport.core.Message from,
                  MqMessageReceivedImpl message,
                  boolean isOk,
                  org.noear.socketd.transport.core.Entity entity)
           throws IOException

消费答复

指定者:

reply 在接口中 MqClientInternal

参数:

session - 会话

from - 来源消息

message - 收到的消息

isOk - 回执

entity - 实体

抛出:

IOException

diversionOrNull

protected String diversionOrNull(String fullTopic,
                                 MqMessage message)

getSubscription

protected MqSubscription getSubscription(String fullTopic,
                                         String consumerGroup)

getSubscriptionAll

protected Collection<MqSubscription> getSubscriptionAll()

getSubscriptionSize

protected int getSubscriptionSize()