/usr/include/sipxtapi/ps/PsMsg.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 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 | //
// Copyright (C) 2006 SIPez LLC.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp. All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$
///////////////////////////////////////////////////////////////////////////////
#ifndef _PsMsg_h_
#define _PsMsg_h_
// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "os/OsMsg.h"
// DEFINES
#define PSMSG_MAX_STRINGPARAM_LENGTH 1024
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class UtlString;
//:Message object used to communicate phone set information
class PsMsg : public OsMsg
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
// Phone set message types
enum PsMsgType
{
/* ----------------------------- LOWLEVEL --------------------------------- */
BUTTON_DOWN,
BUTTON_REPEAT,
BUTTON_UP,
KEY_DOWN, //for true keyboard support on NT
KEY_UP,
HOOKSW_STATE,
KEYPAD_STATE,
SCROLL_CHANGE,
SCROLL_STATE,
TOUCHSCREEN_CHANGE,
TOUCHSCREEN_STATE,
/* ----------------------------- PHONEBUTTON ------------------------------ */
BUTTON_PRESS,
BUTTON_GET_INFO,
BUTTON_SET_INFO,
BUTTON_GET_PHONELAMP,
/* ----------------------------- PHONEHOOKSWITCH -------------------------- */
HOOKSW_GET_STATE,
HOOKSW_SET_STATE,
HOOKSW_GET_CALL,
/* ----------------------------- PHONELAMP -------------------------------- */
LAMP_GET_MODE,
LAMP_GET_SUPPORTED_MODES,
LAMP_GET_BUTTON,
LAMP_SET_MODE,
/* ----------------------------- PHONEDISPLAY ----------------------------- */
DISPLAY_GET_DISPLAY,
DISPLAY_GET_ROWS,
DISPLAY_GET_COLS,
DISPLAY_SET_DISPLAY,
/* ----------------------------- PHONEMIC --------------------------------- */
MIC_GET_GAIN,
MIC_SET_GAIN,
/* ----------------------------- PHONERINGER ------------------------------ */
RINGER_SET_INFO,
RINGER_SET_PATTERN,
RINGER_SET_VOLUME,
RINGER_GET_INFO,
RINGER_GET_PATTERN,
RINGER_GET_VOLUME,
RINGER_GET_MAX_PATTERN_INDEX,
RINGER_GET_NUMBER_OF_RINGS,
RINGER_IS_ON,
/* ----------------------------- PHONESPEAKER ----------------------------- */
SPEAKER_SET_VOLUME,
SPEAKER_GET_VOLUME,
EXTSPEAKER_CONNECT,
EXTSPEAKER_DISCONNECT,
/* ----------------------------- PHONECOMPONENT --------------------------- */
PHONECOMPONENT_GET_TYPE,
PHONECOMPONENT_GET_NAME,
/* ----------------------------- PHONECOMPONENT --------------------------- */
HANDSET_SET_VOLUME,
HANDSET_SET_GAIN,
/* ----------------------------- PHONEGROUP ------------------------------- */
PHONEGROUP_ACTIVATE,
PHONEGROUP_DEACTIVATE,
PHONEGROUP_GET_COMPONENTS,
PHONEGROUP_GET_DESCRIPTION,
PHONEGROUP_GET_TYPE,
PHONEGROUP_IS_ACTIVATED,
/* ----------------------------- TERMINAL --------------------------------- */
TERMINAL_GET_COMPONENT,
TERMINAL_GET_COMPONENTS,
TERMINAL_GET_COMPONENTGROUPS
};
/* ============================ CREATORS ================================== */
PsMsg(int msg, void* source, const int param1, const int param2);
//:Constructor
PsMsg(const PsMsg& rPsMsg);
//:Copy constructor
virtual OsMsg* createCopy(void) const;
//:Create a copy of this msg object (which may be of a derived type)
virtual
~PsMsg();
//:Destructor
/* ============================ MANIPULATORS ============================== */
PsMsg& operator=(const PsMsg& rhs);
//:Assignment operator
void setMsgSource(void* source);
//:Set the message source
void setParam1(int param1);
//:Set parameter1 of the phone set message
void setParam2(int param2);
//:Set parameter2 of the phone set message
void setStringParam1(const char* str);
//:Set string parameter1 of the phone set message
void setStringParam2(const char* str);
//:Set string parameter2 of the phone set message
void setInUse(UtlBoolean isInUse);
//:Set the InUse flag for the message.
// For messages sent from an ISR, TRUE indicates that the receiver is
// not done with the message yet. The InUse flag is ignored for
// messages that were not sent from an ISR.
/* ============================ ACCESSORS ================================= */
virtual int getMsg(void) const;
//:Return the type of the phone set message
virtual void* getMsgSource(void) const;
//:Return the message source
virtual int getParam1(void) const;
//:Return parameter1 of the message
virtual int getParam2(void) const;
//:Return parameter2 of the message
void getStringParam1(UtlString& stringData);
//:Return string parameter1 of the message
void getStringParam2(UtlString& stringData);
//:Return string parameter2 of the message
/* ============================ INQUIRY =================================== */
UtlBoolean isInUse(void);
//:Returns the value of the InUse flag for the message.
// For messages sent from an ISR, TRUE indicates that the receiver is
// not done with the message yet. The InUse flag is ignored for
// messages that were not sent from an ISR.
/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
UtlBoolean mInUse; // For messages sent from an ISR, indicates that
void* mMsgSource; // Message source
int mParam1; // Message parameter 1
int mParam2; // Message parameter 2
char mStringParam1[PSMSG_MAX_STRINGPARAM_LENGTH + 1]; // String parameter 1
char mStringParam2[PSMSG_MAX_STRINGPARAM_LENGTH + 1]; // String parameter 2
// the receiver is not done with the message yet
};
/* ============================ INLINE METHODS ============================ */
#endif // _PsMsg_h_
|