QueueReader.h

Go to the documentation of this file.

//=============================================================================
//  Computational Process Networks class library
//  Copyright (C) 1997-2006  Gregory E. Allen and The University of Texas
//
//  This library is free software; you can redistribute it and/or modify it
//  under the terms of the GNU Library General Public License as published
//  by the Free Software Foundation; either version 2 of the License, or
//  (at your option) any later version.
//
//  This library is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//  Library General Public License for more details.
//
//  The GNU Public License is available in the file LICENSE, or you
//  can write to the Free Software Foundation, Inc., 59 Temple Place -
//  Suite 330, Boston, MA 02111-1307, USA, or you can find it on the
//  World Wide Web at http://www.fsf.org.
//=============================================================================
#ifndef CPN_QUEUEREADER_H
#define CPN_QUEUEREADER_H
#pragma once

#include <cpn/common.h>
#include <string>

namespace CPN {

    class CPN_API QueueReader {
    public:

        QueueReader(QueueReleaser *n, shared_ptr<QueueBase> q);

        ~QueueReader();

        const void* GetRawDequeuePtr(unsigned thresh, unsigned chan=0);

        void Dequeue(unsigned count);

        bool RawDequeue(void *data, unsigned count,
                unsigned numChans, unsigned chanStride);

        bool RawDequeue(void *data, unsigned count);

        void Reset();

        bool Flushed() const;

        unsigned NumChannels() const;

        unsigned MaxThreshold() const;

        unsigned QueueLength() const;
        unsigned Count() const;

        bool Empty() const;

        const std::string &GetDatatype() const;

        unsigned ChannelStride() const;

        Key_t GetKey() const;

        void Release();

        void NotifyTerminate();

        shared_ptr<QueueBase> GetQueue() { return queue; }
    private:
        QueueReleaser *releaser;
        shared_ptr<QueueBase> queue;
    };
}
#endif