/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

package org.apache.pulsar.storm;

import java.util.concurrent.TimeUnit;

import org.apache.pulsar.client.api.Message;
import org.apache.pulsar.client.api.PulsarClientException;

public interface PulsarSpoutConsumer {

    /**
     * Receives a single message.
     * 
     * @param waitTime - time
     * @param unit - time unit
     * @return message
     * @throws PulsarClientException in case of error
     */
    Message<byte[]> receive(int waitTime, TimeUnit unit) throws PulsarClientException;
    
    /**
     * Ack the message async.
     * 
     * @param msg - message to ack
     */
    void acknowledgeAsync(Message<?> msg);

    /**
     * unsubscribe the consumer.
     * @throws PulsarClientException in case of error
     */
    void unsubscribe() throws PulsarClientException;
    
    /**
     * Close the consumer.
     * 
     * @throws PulsarClientException in case of error
     */
    void close() throws PulsarClientException;

}
