/*
 * (C) 2007-2012 Alibaba Group Holding Limited.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * Authors:
 *   wuhua <wq163@163.com> , boyan <killme2008@gmail.com>
 */
package com.taobao.metamorphosis.client.consumer;

import java.util.Collection;
import java.util.concurrent.TimeUnit;

import com.taobao.metamorphosis.client.Shutdownable;
import com.taobao.metamorphosis.client.consumer.storage.OffsetStorage;
import com.taobao.metamorphosis.cluster.Partition;
import com.taobao.metamorphosis.consumer.ConsumerMessageFilter;
import com.taobao.metamorphosis.consumer.MessageIterator;
import com.taobao.metamorphosis.exception.MetaClientException;


/**
 * ��Ϣ�����ߣ��̰߳�ȫ���Ƽ�����
 * 
 * @author boyan
 * @Date 2011-4-21
 * 
 */
public interface MessageConsumer extends Shutdownable {

    /**
     * ��ȡָ��topic�ͷ����������Ϣ��Ĭ�ϳ�ʱ10��
     * 
     * @param topic
     * @param partition
     * @return ��Ϣ������������Ϊnull
     */
    public MessageIterator get(String topic, Partition partition, long offset, int maxSize) throws MetaClientException,
    InterruptedException;


    /**
     * ��ȡָ��topic�ͷ����������Ϣ����ָ��ʱ����û�з������׳��쳣
     * 
     * @param topic
     * @param partition
     * @param timeout
     * @param timeUnit
     * @return ��Ϣ������������Ϊnull
     * @throws TimeoutException
     */
    public MessageIterator get(String topic, Partition partition, long offset, int maxSize, long timeout,
            TimeUnit timeUnit) throws MetaClientException, InterruptedException;


    /**
     * ����ָ������Ϣ������MessageListener��������Ϣ�ﵽ��ʱ������֪ͨMessageListener����ע�⣬
     * ���ô˷���������ʹ���Ĺ�ϵ������Ч�� ֻ���ڵ���complete���������Ч���˷���������ʽ����
     * 
     * @param topic
     *            ���ĵ�topic
     * @param maxSize
     *            ����ÿ�ν��յ�������ݴ�С
     * @param messageListener
     *            ��Ϣ������
     */
    public MessageConsumer subscribe(String topic, int maxSize, MessageListener messageListener)
            throws MetaClientException;


    /**
     * ����ָ������Ϣ������MessageListener��ConsumerMessageFilter��
     * ������Ϣ���ﲢ��ConsumerMessageFilter
     * #accept����true��ʱ��,����֪ͨMessageListener������Ϣ����ע�⣬ ���ô˷���������ʹ���Ĺ�ϵ������Ч��
     * ֻ���ڵ���complete���������Ч���˷���������ʽ����
     * 
     * @param topic
     *            ���ĵ�topic
     * @param maxSize
     *            ����ÿ�ν��յ�������ݴ�С
     * @param messageListener
     * @param ConsumerMessageFilter
     *            message filter ��Ϣ������
     */
    public MessageConsumer subscribe(String topic, int maxSize, MessageListener messageListener,
            ConsumerMessageFilter consumerMessageFilter) throws MetaClientException;


    /**
     * ����������Ϣ,��ע�⣬���ô˷���������ʹ���Ĺ�ϵ������Ч��ֻ���ڵ���complete���������Ч��
     * 
     * @param subscriptions
     */
    public void setSubscriptions(Collection<Subscription> subscriptions) throws MetaClientException;


    /**
     * ʹ���Ѿ����ĵ�topic��Ч,�˷������ܵ���һ��,�ٴε�����Ч�����׳��쳣
     */
    public void completeSubscribe() throws MetaClientException;


    /**
     * ���ش�������ʹ�õ�offset�洢�����ɹ��������������
     * 
     * @return
     */
    public OffsetStorage getOffsetStorage();


    /**
     * ֹͣ������
     */
    @Override
    public void shutdown() throws MetaClientException;


    /**
     * ��������������
     * 
     * @return
     */
    public ConsumerConfig getConsumerConfig();

    /**
     * Returns current RejectConsumptionHandler
     *
     * @return
     */
    public RejectConsumptionHandler getRejectConsumptionHandler();

    /**
     * Sets RejectConsumptionHandler for this consumer.
     *
     * @param rejectConsumptionHandler
     */
    public void setRejectConsumptionHandler(RejectConsumptionHandler rejectConsumptionHandler);
}