QueueBase.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_QUEUEBASE_H
#define CPN_QUEUEBASE_H
#pragma once

#include "common_priv.h"
#include <cpn/threading/PthreadMutex.h>
#include <cpn/threading/PthreadCondition.h>
#include <cpn/d4r/D4RQueue.h>
#include <cpn/utils/Logger.h>

namespace CPN {

    class CPN_LOCAL QueueBase : public D4R::QueueBase {
    public:

        virtual ~QueueBase();

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

        void Dequeue(unsigned count);

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

        bool RawDequeue(void *data, unsigned count);

        void *GetRawEnqueuePtr(unsigned thresh, unsigned chan);

        void Enqueue(unsigned count);

        void RawEnqueue(const void *data, unsigned count,
                unsigned numChans, unsigned chanStride);

        void RawEnqueue(const void *data, unsigned count);

        void Reset();
        void Flush();
        bool Flushed() const;

        unsigned NumChannels() const;

        unsigned Count() const;

        bool Empty() const;

        unsigned Freespace() const;

        bool Full() const;

        unsigned MaxThreshold() const;

        unsigned QueueLength() const;

        unsigned EnqueueChannelStride() const;
        unsigned DequeueChannelStride() const;

        void Grow(unsigned queueLen, unsigned maxThresh);

        Key_t GetWriterKey() const { return writerkey; }
        Key_t GetReaderKey() const { return readerkey; }
        const std::string &GetDatatype() const { return datatype; }
        void ShutdownReader();
        void ShutdownWriter();
        void NotifyTerminate();

        void Lock() const { lock.Lock(); }
        void Unlock() const { lock.Unlock(); }

        unsigned ReadRequest();
        unsigned WriteRequest();
        bool IsReaderShutdown();
        bool IsWriterShutdown();

        virtual void LogState();

        unsigned NumEnqueued() const;
        unsigned NumDequeued() const;
    protected:
        QueueBase(KernelBase *k, const SimpleQueueAttr &attr);

        virtual void WaitForData();
        virtual bool ReadBlocked();
        void NotifyData();
        virtual void WaitForFreespace();
        virtual bool WriteBlocked();
        void NotifyFreespace();

        virtual void Wait() { cond.Wait(lock); }
        virtual void Signal() { cond.Broadcast(); }

        virtual void Detect();

        virtual const void *InternalGetRawDequeuePtr(unsigned thresh, unsigned chan) = 0;
        virtual void InternalDequeue(unsigned count) = 0;
        virtual void *InternalGetRawEnqueuePtr(unsigned thresh, unsigned chan) = 0;
        virtual void InternalEnqueue(unsigned count) = 0;

        virtual void InternalFlush();
        virtual void InternalReset();
        virtual unsigned UnlockedNumChannels() const = 0;
        virtual unsigned UnlockedCount() const = 0;
        virtual bool UnlockedEmpty() const = 0;
        virtual unsigned UnlockedFreespace() const = 0;
        virtual bool UnlockedFull() const = 0;
        virtual unsigned UnlockedMaxThreshold() const = 0;
        virtual unsigned UnlockedQueueLength() const = 0;
        virtual unsigned UnlockedEnqueueChannelStride() const = 0;
        virtual unsigned UnlockedDequeueChannelStride() const = 0;
        virtual void UnlockedGrow(unsigned queueLen, unsigned maxThresh) = 0;
        virtual void UnlockedShutdownReader();
        virtual void UnlockedShutdownWriter();
        virtual unsigned UnlockedNumEnqueued() const = 0;
        virtual unsigned UnlockedNumDequeued() const = 0;

        const Key_t readerkey;
        const Key_t writerkey;
        bool readshutdown;
        bool writeshutdown;
        unsigned prepad;
        unsigned postpad;
        unsigned readrequest;
        unsigned writerequest;
        unsigned enqueuethresh;
        unsigned dequeuethresh;
        bool indequeue;
        bool inenqueue;
        bool flushed;
        KernelBase *kernel;
        bool useD4R;
        Logger logger;
        mutable PthreadMutex lock;
        PthreadCondition cond;
        std::string datatype;
    };

}
#endif