MpResourceMsg.h

Go to the documentation of this file.

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

#ifndef _MpResourceMsg_h_
#define _MpResourceMsg_h_

// SYSTEM INCLUDES

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

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

class MpResourceMsg : public OsMsg
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

   typedef enum
   {
      MPRM_RESOURCE_ENABLE,            
      MPRM_RESOURCE_DISABLE,           
      MPRM_ENABLE_ALL_NOTIFICATIONS,   
      MPRM_DISABLE_ALL_NOTIFICATIONS,  

      MPRM_START_TONE,          
      MPRM_STOP_TONE,           

      MPRM_BRIDGE_SET_GAINS,    

      MPRM_DECODE_SELECT_CODECS,  

      MPRM_SET_SOCKETS,         
      MPRM_RESET_SOCKETS,       

      // Add new built in resource operation messages above

      // Non-builtin resource messages
      MPRM_EXTERNAL_MESSAGE_START = 128
      // Do not add new message types after this
   } MpResourceMsgType;

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


   MpResourceMsg(MpResourceMsgType msg, const UtlString& msgDestName);

   MpResourceMsg(const MpResourceMsg& rMpResourceMsg);

   virtual OsMsg* createCopy() const;

   virtual
   ~MpResourceMsg();


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


   MpResourceMsg& operator=(const MpResourceMsg& rhs);

   void setDestResourceName(const UtlString& msgDestName);

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


   int getMsg() const;

   UtlString getDestResourceName() const;

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



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

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
   UtlString mMsgDestName; 
};

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

#endif  // _MpResourceMsg_h_