vmessagequeue.h

Go to the documentation of this file.

/*
Copyright c1997-2014 Trygve Isaacson. All rights reserved.
This file is part of the Code Vault version 4.1
http://www.bombaydigital.com/
License: MIT. See LICENSE.md in the Vault top level directory.
*/

#ifndef vmessagequeue_h
#define vmessagequeue_h

#include "vtypes.h"
#include "vmutex.h"
#include "vsemaphore.h"
#include "vcompactingdeque.h"
#include "vmessage.h"

class VMessageQueue {
    public:

        VMessageQueue();
        virtual ~VMessageQueue();

        virtual void postMessage(VMessagePtr message);
        VMessagePtr blockUntilNextMessage();
        VMessagePtr getNextMessage();
        void wakeUp();
        VSizeType getQueueSize() const;
        Vs64 getQueueDataSize() const;
        void releaseAllMessages();

        static void setQueueingLagLoggingThreshold(const VDuration& threshold) { gVMessageQueueLagLoggingThreshold = threshold; }
        static VDuration getQueueingLagLoggingThreshold() { return gVMessageQueueLagLoggingThreshold; }
        static void setQueueingLagLoggingLevel(int logLevel) { gVMessageQueueLagLoggingLevel = logLevel; }
        static int getQueueingLagLoggingLevel() { return gVMessageQueueLagLoggingLevel; }

    private:

        VCompactingDeque<VMessagePtr> mQueuedMessages;
        Vs64            mQueuedMessagesDataSize;    
        VMutex          mMessageQueueMutex;         
        VSemaphore      mMessageQueueSemaphore;     
        VInstant        mLastMessagePostTime;       

        static VDuration gVMessageQueueLagLoggingThreshold; 
        static int gVMessageQueueLagLoggingLevel;           
};

#endif /* vmessagequeue_h */