OsMsgQShared.h

Go to the documentation of this file.

//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$


#ifndef _OsMsgQShared_h_
#define _OsMsgQShared_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include "os/OsCSem.h"
#include "os/OsDefs.h"
#include "os/OsMsg.h"
#include "os/OsMsgQ.h"
#include "os/OsMutex.h"
#include "os/OsTime.h"
#include "utl/UtlDList.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
class UtlString;

// FORWARD DECLARATIONS

// #define OS_MSGQ_DEBUG
// #define OS_MSGQ_REPORTING

// debug class
class DebugMutex
{
   public:
   DebugMutex(OsMutex& mutex, const char* label)
   {
      printf("DebugMutex %s:\n", label);
      mutex.OsMutexShow();
   };

   private:
   DebugMutex();
};

class OsMsgQShared : public OsMsgQBase
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

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

   OsMsgQShared(
      const int       maxMsgs=DEF_MAX_MSGS,      
      const int       maxMsgLen=DEF_MAX_MSG_LEN, 
      const int       options=Q_PRIORITY,        
      const UtlString& name=""                   
      );
   virtual  ~OsMsgQShared();

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

   virtual OsStatus send(const OsMsg& rMsg,
                         const OsTime& rTimeout=OsTime::OS_INFINITY);

   virtual OsStatus sendNoCopy(OsMsg *pMsg,
                               const OsTime& rTimeout=OsTime::OS_INFINITY);

   virtual OsStatus sendUrgent(const OsMsg& rMsg,
                               const OsTime& rTimeout=OsTime::OS_INFINITY);

   virtual OsStatus sendFromISR(OsMsg& rMsg);

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

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

#ifdef OS_MSGQ_DEBUG
   int getFullCount() { return mFull.getValue();}
   int getEmptyCount() { return mEmpty.getValue();}
   UtlDList& getList() { return mDlist;} 
#endif

   virtual int numMsgs();

#ifdef MSGQ_IS_VALID_CHECK 
   virtual void show();
#endif

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

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

#ifdef MSGQ_IS_VALID_CHECK 
   virtual void testMessageQ();
#endif


/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
   OsMutex  mGuard;  
   OsCSem   mEmpty;  
   OsCSem   mFull;   
   UtlDList mDlist;  

#ifdef MSGQ_IS_VALID_CHECK
   int      mOptions; 
   int      mHighCnt; 
#endif

#ifdef OS_MSGQ_REPORTING
   int      mIncreaseLevel;   
   int      mDecreaseLevel;   
   int      mIncrementLevel;  
#endif

   OsStatus doSend(const OsMsg& rMsg, const OsTime& rTimeout,
                   const UtlBoolean isUrgent, const UtlBoolean needCopy);

   OsStatus doReceive(OsMsg*& rpMsg, const OsTime& rTimeout);

   OsMsgQShared(const OsMsgQShared& rOsMsgQShared);

   OsMsgQShared& operator=(const OsMsgQShared& rhs);

};

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

#endif  // _OsMsgQShared_h_