org.noear.folkmq.client

接口 MqClient

所有超级接口:

AutoCloseable, Closeable

所有已知子接口:

MqClientInternal

所有已知实现类:

MqClientDefault

public interface MqClient
extends Closeable

消息客户端

从以下版本开始:

1.0, 1.2

作者:

noear

方法概要

限定符和类型	方法和说明
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() 断开连接
void	listen(MqConsumeHandler listenHandler) 监听
String	name() 名字
MqClient	nameAs(String name) 名字取为
MqTransaction	newTransaction() 新建事务
void	publish(String topic, MqMessage message) 同步发布消息
CompletableFuture<Boolean>	publishAsync(String topic, MqMessage message) 异步发布消息
default org.noear.socketd.transport.stream.RequestStream	send(MqMessage message, String toName) 发送
org.noear.socketd.transport.stream.RequestStream	send(MqMessage message, String toName, long timeout) 发送
default void	subscribe(String topic, MqConsumeHandler consumerHandler) 订阅主题
void	subscribe(String topic, String consumerGroup, boolean autoAck, MqConsumeHandler consumerHandler) 订阅主题
default void	subscribe(String topic, String consumerGroup, MqConsumeHandler consumerHandler) 订阅主题
MqClient	transactionCheckback(MqTransactionCheckback transactionCheckback) 事务回查
void	unpublish(String topic, String tid) 取消发布
CompletableFuture<Boolean>	unpublishAsync(String topic, String tid) 取消发布
default void	unsubscribe(String topic) 取消订阅主题
void	unsubscribe(String topic, String consumerGroup) 取消订阅主题

从接口继承的方法 java.io.Closeable

close

方法详细资料

name

String name()

名字

nameAs

MqClient nameAs(String name)

名字取为

connect

MqClient connect()
          throws IOException

连接

抛出:

IOException

disconnect

void disconnect()
         throws IOException

断开连接

抛出:

IOException

config

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

客户端配置

consumeExecutor

MqClient consumeExecutor(ExecutorService consumeExecutor)

消费执行器

autoAcknowledge

MqClient autoAcknowledge(boolean auto)

自动回执

参数:

auto - 自动（默认为 true）

autoAcknowledge

boolean autoAcknowledge()

自动回执

call

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

接口调用

抛出:

IOException

subscribe

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

订阅主题

参数:

topic - 主题

consumerGroup - 消费者组

autoAck - 是否自动回执

consumerHandler - 消费处理

抛出:

IOException

subscribe

default void subscribe(String topic,
                       String consumerGroup,
                       MqConsumeHandler consumerHandler)
                throws IOException

订阅主题

参数:

topic - 主题

consumerGroup - 消费者组

consumerHandler - 消费处理

抛出:

IOException

subscribe

default void subscribe(String topic,
                       MqConsumeHandler consumerHandler)
                throws IOException

订阅主题

参数:

topic - 主题

consumerHandler - 消费处理

抛出:

IOException

unsubscribe

void unsubscribe(String topic,
                 String consumerGroup)
          throws IOException

取消订阅主题

参数:

topic - 主题

consumerGroup - 消费者组

抛出:

IOException

unsubscribe

default void unsubscribe(String topic)
                  throws IOException

取消订阅主题

参数:

topic - 主题

抛出:

IOException

publish

void publish(String topic,
             MqMessage message)
      throws IOException

同步发布消息

参数:

topic - 主题

message - 消息

抛出:

IOException

publishAsync

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

异步发布消息

参数:

topic - 主题

message - 消息

抛出:

IOException

unpublish

void unpublish(String topic,
               String tid)
        throws IOException

取消发布

参数:

topic - 主题

tid - 跟踪id

抛出:

IOException

unpublishAsync

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

取消发布

参数:

topic - 主题

tid - 跟踪id

抛出:

IOException

listen

void listen(MqConsumeHandler listenHandler)

监听

参数:

listenHandler - 监听处理

send

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

发送

参数:

message - 消息

toName - 发送目标名字

timeout - 超时（单位毫秒）

抛出:

IOException

send

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

发送

参数:

message - 消息

toName - 发送目标名字

抛出:

IOException

transactionCheckback

MqClient transactionCheckback(MqTransactionCheckback transactionCheckback)

事务回查

参数:

transactionCheckback - 事务回查处理

newTransaction

MqTransaction newTransaction()

新建事务