org.noear.folkmq.client

接口 MqClient

所有超级接口:

AutoCloseable, Closeable

所有已知子接口:

MqClientInternal

所有已知实现类:

MqClientDefault

public interface MqClient
extends Closeable

消息客户端

从以下版本开始:

1.0

作者:

noear

方法概要

限定符和类型	方法和说明
MqClient	autoAcknowledge(boolean auto) 自动回执
MqClient	config(org.noear.socketd.transport.client.ClientConfigHandler configHandler) 客户端配置
MqClient	connect() 连接
void	disconnect() 断开连接
void	publish(String topic, IMqMessage message) 同步发布消息
CompletableFuture<Boolean>	publishAsync(String topic, IMqMessage message) 异步发布消息
void	subscribe(String topic, String consumerGroup, MqConsumeHandler consumerHandler) 订阅主题
void	unpublish(String topic, String tid) 取消发布
CompletableFuture<Boolean>	unpublishAsync(String topic, String tid) 取消发布
void	unsubscribe(String topic, String consumerGroup) 取消订阅主题

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

close

方法详细资料

connect

MqClient connect()
          throws IOException

连接

抛出:

IOException

disconnect

void disconnect()
         throws IOException

断开连接

抛出:

IOException

config

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

客户端配置

autoAcknowledge

MqClient autoAcknowledge(boolean auto)

自动回执

参数:

auto - 自动（默认为 true）

subscribe

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

订阅主题

参数:

topic - 主题

consumerGroup - 消费者组

consumerHandler - 消费处理

抛出:

IOException

unsubscribe

void unsubscribe(String topic,
                 String consumerGroup)
          throws IOException

取消订阅主题

参数:

topic - 主题

consumerGroup - 消费者组

抛出:

IOException

publish

void publish(String topic,
             IMqMessage message)
      throws IOException

同步发布消息

参数:

topic - 主题

message - 消息

抛出:

IOException

publishAsync

CompletableFuture<Boolean> publishAsync(String topic,
                                        IMqMessage 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