com.aliyun.openservices.ons.api.Consumer 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;

/**
 * 消息消费者接口，用来订阅消息
 */
public interface Consumer extends Admin {
    /**
     * 订阅消息
     *
     * @param topic
     *         消息主题
     * @param subExpression
     *         订阅过滤表达式字符串，ONS服务器依据此表达式进行过滤。只支持或运算

     *         eg: "tag1 || tag2 || tag3"

     *         如果subExpression等于null或者*，则表示全部订阅
     * @param listener
     *         消息回调监听器
     */
    void subscribe(final String topic, final String subExpression, final MessageListener listener);

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


    /**
     * 取消某个topic订阅
     *
     * @param topic 要取消的主题.
     */
    void unsubscribe(final String topic);
}