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-api Show documentation

There is a newer version: 2.0.7.Final

package com.aliyun.openservices.ons.api;

/**
 * 消息消费者，用来订阅消息
 */
public interface Consumer extends Admin {
    /**
     * 启动服务
     */
    public void start();


    /**
     * 关闭服务
     */
    public void shutdown();


    /**
     * 订阅消息
     *
     * @param topic
     *         消息主题
     * @param subExpression
     *         订阅过滤表达式字符串，ONS服务器依据此表达式进行过滤。只支持或运算

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

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


    /**
     * 取消某个topic订阅
     *
     * @param topic
     */
    public void unsubscribe(final String topic);
}