OsMsgDispatcher.h

Go to the documentation of this file.

//  
// Copyright (C) 2007 SIPez LLC. 
// Licensed to SIPfoundry under a Contributor Agreement. 
//
// Copyright (C) 2007 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// $$

// Author: Keith Kyzivat <kkyzivat AT SIPez DOT com>

#ifndef _OsMsgDispatcher_h_
#define _OsMsgDispatcher_h_

// SYSTEM INCLUDES
#include <os/OsMsgQ.h>

// APPLICATION INCLUDES
#include "os/OsMsg.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS

class OsMsgDispatcher
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

/* ============================ CREATORS ================================== */


   OsMsgDispatcher();
   OsMsgDispatcher(OsMsgQ* msgQ);
   virtual ~OsMsgDispatcher();


/* ============================ MANIPULATORS ============================== */

   virtual OsStatus post(const OsMsg& msg);
   virtual OsStatus receive(OsMsg*& rpMsg,
                            const OsTime& rTimeout=OsTime::OS_INFINITY);

/* ============================ ACCESSORS ================================= */


   inline virtual int numMsgs(void);

   inline int maxMsgs() const;

/* ============================ INQUIRY =================================== */


   inline virtual UtlBoolean isEmpty(void);

   inline UtlBoolean isMsgsLost() const;


/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

   OsMsgQ* mMsgQueue; 
   UtlBoolean mQueueOwned; 

   UtlBoolean mMsgsLost; 

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:

   inline void setMsgsLost();

   OsMsgDispatcher(const OsMsgDispatcher& rMsgDispatcher);

   OsMsgDispatcher& operator=(const OsMsgDispatcher& rhs);
};

/* ============================ INLINE METHODS ============================ */


int OsMsgDispatcher::numMsgs( void )
{
   return mMsgQueue->numMsgs();
}

int OsMsgDispatcher::maxMsgs() const
{
   return mMsgQueue->maxMsgs();
}

UtlBoolean OsMsgDispatcher::isEmpty( void )
{
   return mMsgQueue->isEmpty();
}

UtlBoolean OsMsgDispatcher::isMsgsLost() const
{
   return mMsgsLost;
}

void OsMsgDispatcher::setMsgsLost()
{
    mMsgsLost = TRUE;
}

#endif  // _OsMsgDispatcher_h_