OsMsgQ.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 _OsMsgQ_h_
#define _OsMsgQ_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include "os/OsDefs.h"
#include "os/OsStatus.h"
#include "os/OsTime.h"
#include "utl/UtlString.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS

// FORWARD DECLARATIONS
class OsMsg;

// TYPEDEFS
typedef UtlBoolean (*OsMsgQSendHookPtr) (const OsMsg& rMsg);
typedef void      (*OsMsgQFlushHookPtr) (const OsMsg& rMsg);

//:Message queue for inter-task communication

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

   static const int DEF_MAX_MSGS;      
   static const int DEF_MAX_MSG_LEN;   
   static const UtlString MSGQ_PREFIX; 

   enum Options
   {
      Q_FIFO     = 0x0, 
      Q_PRIORITY = 0x1  
   };


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

   OsMsgQBase(const UtlString& name);
   virtual ~OsMsgQBase();

   static OsMsgQBase* getMsgQByName(const UtlString& name);

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


   virtual OsStatus send(const OsMsg& rMsg,
                         const OsTime& rTimeout=OsTime::OS_INFINITY) = 0;
   virtual OsStatus sendNoCopy(OsMsg *pMsg,
                               const OsTime& rTimeout=OsTime::OS_INFINITY) = 0;
   virtual OsStatus sendUrgent(const OsMsg& rMsg,
                               const OsTime& rTimeout=OsTime::OS_INFINITY) = 0;
   virtual OsStatus sendFromISR(OsMsg& rMsg) = 0;
   virtual OsStatus receive(OsMsg*& rpMsg,
                            const OsTime& rTimeout=OsTime::OS_INFINITY) = 0;
   virtual void flush();

   virtual void setSendHook(OsMsgQSendHookPtr func);
   virtual void setFlushHook(OsMsgQFlushHookPtr func);
/* ============================ ACCESSORS ================================= */

   virtual int numMsgs() = 0;

   int maxMsgs() const;

   virtual OsMsgQSendHookPtr getSendHook() const;

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

   virtual UtlBoolean isEmpty();
     
   const UtlString& getName() const { return mName; }

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

   OsMsgQSendHookPtr  mSendHookFunc;

   OsMsgQFlushHookPtr mFlushHookFunc;

/* ---------------------------- DEBUG SCAFFOLDING ------------------------- */
protected:

   int      mMaxMsgs; 

#if MSGQ_IS_VALID_CHECK
   virtual void testMessageQ() = 0;

   unsigned int mNumInsertEntry;
   unsigned int mNumInsertExitOk;
   unsigned int mNumInsertExitFail;

   unsigned int mNumRemoveEntry;
   unsigned int mNumRemoveExitOk;
   unsigned int mNumRemoveExitFail;

   unsigned int mLastSuccessTest;
#endif

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

   UtlString mName;   

   OsMsgQBase(const OsMsgQBase& rOsMsgQBase);

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

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

// Depending on the native OS that we are running on, we include the class
// declaration for the appropriate lower level implementation and use a
// "typedef" statement to associate the OS-independent class name (OsMsgQ)
// with the OS-dependent realization of that type (e.g., OsMsgQWnt).
#if defined(_WIN32)
#  include "os/shared/OsMsgQShared.h"
   typedef class OsMsgQShared OsMsgQ;
#elif defined(_VXWORKS)
#  include "os/Vxw/OsMsgQVxw.h"
   typedef class OsMsgQVxw OsMsgQ;
#elif defined(__pingtel_on_posix__)
#  include "os/shared/OsMsgQShared.h"
   typedef class OsMsgQShared OsMsgQ;
#else
#  error Unsupported target platform.
#endif

#endif  // _OsMsgQ_h_