BlockingQueue.h

Go to the documentation of this file.

/*
 * 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.
 */

#ifndef _DECAF_UTIL_CONCURRENT_BLOCKINGQUEUE_H_
#define _DECAF_UTIL_CONCURRENT_BLOCKINGQUEUE_H_

#include <decaf/util/Config.h>
#include <decaf/util/AbstractQueue.h>

#include <decaf/util/concurrent/TimeUnit.h>
#include <decaf/lang/exceptions/InterruptedException.h>

namespace decaf {
namespace util {
namespace concurrent {

    template< typename E >
    class BlockingQueue : public AbstractQueue<E> {
    public:

        virtual ~BlockingQueue() {
        }

        using Queue<E>::offer;
        using Queue<E>::poll;

        virtual void put( const E& value ) = 0;

        virtual bool offer( const E& e, long long timeout, const TimeUnit& unit ) = 0;

        virtual E take() = 0;

        virtual bool poll( E& result, long long timeout, const TimeUnit& unit ) = 0;

        virtual int remainingCapacity() const = 0;

        virtual int drainTo( Collection<E>& c ) = 0;

        virtual int drainTo( Collection<E>& c, int maxElements ) = 0;

    };

}}}

#endif /* _DECAF_UTIL_CONCURRENT_BLOCKINGQUEUE_H_ */