vmessageoutputthread.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 vmessageoutputthread_h
#define vmessageoutputthread_h

#include "vsocketthread.h"
#include "vsocketstream.h"
#include "vbinaryiostream.h"
#include "vmessage.h"
#include "vmessagequeue.h"
#include "vclientsession.h"

class VServer;

class VMessageOutputThread : public VSocketThread {
    public:

        VMessageOutputThread(const VString& threadBaseName, VSocket* socket, VListenerThread* ownerThread, VServer* server, VClientSessionPtr session, VMessageInputThread* dependentInputThread, int maxQueueSize = 0, Vs64 maxQueueDataSize = 0, const VDuration& maxQueueGracePeriod = VDuration::ZERO());
        virtual ~VMessageOutputThread();

        virtual void run();

        virtual void stop();

        void attachSession(VClientSessionPtr session);

        bool postOutputMessage(VMessagePtr message, bool respectQueueLimits = true);

        void releaseAllQueuedMessages();

        int getOutputQueueSize() const;
        bool isOutputQueueOverLimit(int& currentQueueSize, Vs64& currentQueueDataSize) const;

    private:

        VMessageOutputThread(const VMessageOutputThread&); // not copyable
        VMessageOutputThread& operator=(const VMessageOutputThread&); // not assignable

        void _processNextOutboundMessage();

        VMessageQueue           mOutputQueue;       
        VSocketStream           mSocketStream;      
        VBinaryIOStream         mOutputStream;      
        VServer*                mServer;            
        VClientSessionPtr       mSession;           
        VMessageInputThread*    mDependentInputThread;
        int                     mMaxQueueSize;      
        Vs64                    mMaxQueueDataSize;  
        VDuration               mMaxQueueGracePeriod;
        VInstant                mWhenMaxQueueSizeWarned;

        // These are the transient flags we use to enforce and monitor the queue limits.
        bool        mWasOverLimit;      
        VInstant    mWhenWentOverLimit; 
};

#endif /* vmessageoutputthread_h */