com.aliyun.openservices.ons.api.order.OrderConsumer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ons-client-ext Show documentation

There is a newer version: 1.9.3.Final

package com.aliyun.openservices.ons.api.order;

import com.aliyun.openservices.ons.api.Admin;
import com.aliyun.openservices.ons.api.MessageSelector;


/**
 * 顺序消息消费者接口
 */
public interface OrderConsumer extends Admin {
    /**
     * 启动服务
     */
    @Override
    void start();

    /**
     * 关闭服务
     */
    @Override
    void shutdown();

    /**
     * 订阅消息
     *
     * @param topic 消息主题
     * @param subExpression 订阅过滤表达式字符串，broker依据此表达式进行过滤。目前只支持或运算
 eg: "tag1 || tag2 || tag3"

     * 如果subExpression等于null或者*，则表示全部订阅
     * @param listener 消息回调监听器，客户端接收到消息后传给消息回调监听器进行消费
     */
    void subscribe(final String topic, final String subExpression, final MessageOrderListener listener);

    /**
     * 订阅消息，可以使用SQL表达式对消息进行过滤，请注意，SQL表达式过滤只针对MQ铂金版用户，公网服务暂时不支持。
     *
     * @param topic
     *         消息主题
     * @param selector
     *         订阅消息选择器（可空，表示不做过滤），ONS服务器依据此选择器中的表达式进行过滤。
     *         目前支持两种表达式语法：{@link com.aliyun.openservices.ons.api.ExpressionType#TAG}, {@link com.aliyun.openservices.ons.api.ExpressionType#SQL92}
     *         其中，TAG过滤的效果和上面的接口一致
     * @param listener
     *         消息回调监听器
     */
    void subscribe(final String topic, final MessageSelector selector, final MessageOrderListener listener);
}