/usr/include/sipxtapi/mp/MpResNotificationMsg.h is in libsipxtapi-dev 3.3.0~test17-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 | //
// Copyright (C) 2007-2011 SIPez LLC. All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// 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
/// Message notification object used to communicate information from resources
/// outward towards the flowgraph, and up through to users above mediaLib and beyond.
class MpResNotificationMsg : public OsMsg
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
/// Phone set message types
typedef enum
{
MPRNM_MESSAGE_INVALID, ///< Message type is invalid (similar to NULL)
MPRNM_MESSAGE_ALL = MPRNM_MESSAGE_INVALID, ///< Select all message types (used in enabling/disabling)
MPRNM_FROMFILE_STARTED,
MPRNM_FROMFILE_PAUSED,
MPRNM_FROMFILE_RESUMED,
MPRNM_FROMFILE_STOPPED,
MPRNM_FROMFILE_FINISHED, ///< Audio energy level (MprnIntMsg)
MPRNM_FROMFILE_ERROR,
MPRNM_FROMFILE_PROGRESS, ///< Value for MprnProgressMsg notifications.
MPRNM_RECORDER_STARTED, ///< Recording started.
MPRNM_RECORDER_STOPPED, ///< Recording stopped manually (MprnIntMsg bears number of recorded samples).
MPRNM_RECORDER_FINISHED, ///< Recording stopped automatically (MprnIntMsg bears number of recorded samples).
MPRNM_RECORDER_ERROR, ///< Recording stopped because of an error.
MPRNM_DTMF_RECEIVED, ///< Value for MprnDTMFMsg notifications.
MPRNM_DELAY_SPEECH_STARTED,
MPRNM_DELAY_NO_DELAY,
MPRNM_DELAY_QUIESCENCE,
MPRNM_RX_STREAM_ACTIVITY, ///< Value for MprnRtpStreamActivityMsg notifications.
MPRNM_ENERGY_LEVEL, ///< Audio energy level (MprnIntMsg)
MPRNM_VOICE_STARTED,
MPRNM_VOICE_STOPPED,
MPRNM_H264_SPS,
MPRNM_H264_PPS
} RNMsgType;
/* ============================ CREATORS ================================== */
///@name Creators
//@{
/// Constructor
MpResNotificationMsg(RNMsgType msgType,
const UtlString& namedResOriginator,
MpConnectionID connId = MP_INVALID_CONNECTION_ID,
int streamId = -1);
/// Copy constructor
MpResNotificationMsg(const MpResNotificationMsg& rMpResNotifyMsg);
/// Create a copy of this msg object (which may be of a derived type)
virtual OsMsg* createCopy(void) const;
/// Destructor
virtual ~MpResNotificationMsg();
//@}
/* ============================ MANIPULATORS ============================== */
///@name Manipulators
//@{
/// Assignment operator
MpResNotificationMsg& operator=(const MpResNotificationMsg& rhs);
/// Set the name of the resource this message applies to.
void setOriginatingResourceName(const UtlString& resOriginator);
/**<
* Sets the name of the intended recipient for this message.
*/
/// Set the connection ID that this notification is associated with.
void setConnectionId(MpConnectionID connId);
/// @brief Set the stream number inside the connection this notification
/// is associated with.
void setStreamId(int streamId);
//@}
/* ============================ ACCESSORS ================================= */
///@name Accessors
//@{
/// Returns the type of the media resource notification message
int getMsg() const;
/// Get the name of the resource that originated this message.
UtlString getOriginatingResourceName() const;
/**<
* Returns the name of the MpResource object that originated this
* message.
*/
/// Get the connection ID that this message is associated with.
MpConnectionID getConnectionId() const;
/// @brief Get the stream number inside the connection this notification
/// is associated with.
int getStreamId() const;
//@}
/* ============================ INQUIRY =================================== */
///@name Inquiry
//@{
//@}
/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
UtlString mMsgOriginatorName; ///< Name of the resource that originated this message.
MpConnectionID mConnectionId; ///< The ID of the connection this notification
///< is associated with.
int mStreamId; ///< The ID of the stream inside connection
///< this notification is associated with.
};
/* ============================ INLINE METHODS ============================ */
#endif // _MpResNotificationMsg_h_
|