MpResNotificationMsg.h

Go to the documentation of this file.

//  
// Copyright (C) 2007-2021 SIPez LLC.  All rights reserved.
//
// Copyright (C) 2007-2009 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// $$

#ifndef _MpResNotificationMsg_h_
#define _MpResNotificationMsg_h_

// SYSTEM INCLUDES

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

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

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

   typedef enum
   {
      MPRNM_MESSAGE_INVALID, 
      MPRNM_MESSAGE_ALL = MPRNM_MESSAGE_INVALID, 

      MPRNM_FROMFILE_STARTED,
      MPRNM_FROMFILE_PAUSED,
      MPRNM_FROMFILE_RESUMED,
      MPRNM_FROMFILE_STOPPED,
      MPRNM_FROMFILE_FINISHED,  
      MPRNM_FROMFILE_ERROR,
      MPRNM_FROMFILE_PROGRESS,  
      MPRNM_RECORDER_STARTED,   
      MPRNM_RECORDER_PAUSED,    
      MPRNM_RECORDER_RESUMED,   
      MPRNM_RECORDER_STOPPED,   
      MPRNM_RECORDER_FINISHED,  
      MPRNM_RECORDER_ERROR,     
      MPRNM_DTMF_RECEIVED,      
      MPRNM_DELAY_SPEECH_STARTED,
      MPRNM_DELAY_NO_DELAY,
      MPRNM_DELAY_QUIESCENCE,
      MPRNM_RX_STREAM_ACTIVITY, 
      MPRNM_ENERGY_LEVEL,       
      MPRNM_VOICE_STARTED,
      MPRNM_VOICE_STOPPED,
      MPRNM_H264_SPS,
      MPRNM_H264_PPS,
      MPRNM_TONE_DETECT_ON,
      MPRNM_TONE_DETECT_OFF,
      MPRNM_RECORDER_CIRCULARBUFFER_WATERMARK_REACHED,
      MPRNM_INPUT_DEVICE_NOT_PRESENT,
      MPRNM_OUTPUT_DEVICE_NOT_PRESENT,
      MPRNM_INPUT_DEVICE_NOW_PRESENT,
      MPRNM_OUTPUT_DEVICE_NOW_PRESENT
   } RNMsgType;

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


   MpResNotificationMsg(RNMsgType msgType, 
                        const UtlString& namedResOriginator,
                        MpConnectionID connId = MP_INVALID_CONNECTION_ID,
                        int streamId = -1);

   MpResNotificationMsg(const MpResNotificationMsg& rMpResNotifyMsg);

   virtual OsMsg* createCopy(void) const;

   virtual ~MpResNotificationMsg();


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


   MpResNotificationMsg& operator=(const MpResNotificationMsg& rhs);

   void setOriginatingResourceName(const UtlString& resOriginator);
   void setConnectionId(MpConnectionID connId);

   void setStreamId(int streamId);


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


   int getMsg() const;

   UtlString getOriginatingResourceName() const;
   MpConnectionID getConnectionId() const;

   int getStreamId() const;


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



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

   /* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
   UtlString mMsgOriginatorName; 
   MpConnectionID mConnectionId; 
   int mStreamId;                
};

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

#endif  // _MpResNotificationMsg_h_