/usr/include/sipxtapi/mi/MiDtmfNotf.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 | //
// 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 _MiDtmfNotf_h_
#define _MiDtmfNotf_h_
// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "os/OsMsg.h"
#include "utl/UtlString.h"
#include "mi/MiNotification.h"
// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
/// Message notification class used to communicate DTMF signaling.
///
/// If one creates a KEY_DOWN notification, duration other than
/// DURATION_NOT_APPLICABLE should not be supplied, as it isn't
/// useful until a KEY_UP event happens.
class MiDtmfNotf : public MiNotification
{
/* //////////////////////////// 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 ================================== */
///@name Creators
//@{
/// Constructor
MiDtmfNotf(const UtlString& sourceId,
KeyCode key,
KeyPressState pressState,
int32_t duration = DURATION_NOT_APPLICABLE,
int connId = -1,
int streamId = -1);
/// Copy constructor
MiDtmfNotf(const MiDtmfNotf& rNotf);
/// Create a copy of this msg object (which may be of a derived type)
virtual OsMsg* createCopy(void) const;
/// Destructor
virtual ~MiDtmfNotf();
//@}
/* ============================ MANIPULATORS ============================== */
///@name Manipulators
//@{
/// Assignment operator
MiDtmfNotf& operator=(const MiDtmfNotf& rhs);
/// Set the specific DTMF value that this notification represents.
void setKeyCode(KeyCode key);
/// Set the key press state for this DTMF notification -- down or up.
void setKeyPressState(KeyPressState pressState);
/// Set the duration of this DTMF notification.
void setDuration(int32_t duration);
//@}
/* ============================ ACCESSORS ================================= */
///@name Accessors
//@{
/// Get the specific DTMF value that this notification represents.
KeyCode getKeyCode() const;
/// Get the key press state for this DTMF notification -- down or up.
KeyPressState getKeyPressState() const;
/// Get the duration of this DTMF notification.
int32_t getDuration() const;
//@}
/* ============================ INQUIRY =================================== */
///@name Inquiry
//@{
UtlBoolean isPressed() const;
//@}
/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
KeyCode mKey; ///< The DTMF key value.
KeyPressState mPressState; ///< Whether the key is up or down.
int32_t mDuration; ///< Duration of the DTMF event.
};
/* ============================ INLINE METHODS ============================ */
#endif // _MiDtmfNotf_h_
|