MprnDTMFMsg.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 _MprnDTMFMsg_h_
#define _MprnDTMFMsg_h_

// SYSTEM INCLUDES

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

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

class MprnDTMFMsg : public MpResNotificationMsg
{
   /* //////////////////////////// PUBLIC //////////////////////////// */
public:

   static const int32_t DURATION_NOT_APPLICABLE;

   enum KeyPressState
   {
      KEY_UP,
      KEY_DOWN
   };

   enum KeyCode
   {
      DTMF_0 = 0,
      DTMF_1,
      DTMF_2,
      DTMF_3,
      DTMF_4,
      DTMF_5,
      DTMF_6,
      DTMF_7,
      DTMF_8,
      DTMF_9,
      DTMF_STAR = 10,
      DTMF_POUND,
      DTMF_A,
      DTMF_B,
      DTMF_C,
      DTMF_D
   };

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


   MprnDTMFMsg(const UtlString& namedResOriginator,
               KeyCode key,
               KeyPressState pressState,
               int32_t duration = DURATION_NOT_APPLICABLE,
               MpConnectionID connId = MP_INVALID_CONNECTION_ID,
               int streamId = -1);

   MprnDTMFMsg(const MprnDTMFMsg& rMsg);

   virtual OsMsg* createCopy(void) const;

   virtual ~MprnDTMFMsg();


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


   MprnDTMFMsg& operator=(const MprnDTMFMsg& rhs);

   void setKeyCode(KeyCode key);

   void setKeyPressState(KeyPressState pressState);

   void setDuration(int32_t duration);


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


   KeyCode getKeyCode() const;

   KeyPressState getKeyPressState() const;

   int32_t getDuration() const;


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


   UtlBoolean isPressed() const;


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

   /* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
   KeyCode mKey;   
   KeyPressState mPressState;  
   int32_t mDuration;  
};

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

#endif  // _MprnDTMFMsg_h_