/usr/include/sipxtapi/ptapi/PtPhoneLamp.h is in libsipxtapi-dev 3.3.0~test17-2.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 | //
// 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 _PtPhoneLamp_h_
#define _PtPhoneLamp_h_
// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "ptapi/PtDefs.h"
#include "ptapi/PtComponent.h"
#include "os/OsTime.h"
#include "os/OsProtectEventMgr.h"
// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class PtPhoneButton;
class TaoClientTask;
//:The PtPhoneLamp class models phone lamps and other simple indicators.
class PtPhoneLamp : public PtComponent
{
friend class PtPhoneButton;
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
enum IndicatorMode
{
MODE_OFF = 0x00,
MODE_STEADY = 0x01,
MODE_FLASH = 0x02,
MODE_FLUTTER = 0x04,
MODE_BROKENFLUTTER = 0x08,
MODE_WINK = 0x10
};
//!enumcode: MODE_OFF - The indicator mode is off
//!enumcode: MODE_STEADY - The indicator mode is continuously on
//!enumcode: MODE_FLASH - The indicator mode is slow on and off
//!enumcode: MODE_FLUTTER - The indicator mode is fast on and off
//!enumcode: MODE_BROKENFLUTTER - The indicator is the superposition of flash and flutter
//!enumcode: MODE_WINK - The indicator mode is wink
/* ============================ CREATORS ================================== */
PtPhoneLamp(const PtPhoneLamp& rPtPhoneLamp);
//:Copy constructor
PtPhoneLamp(TaoClientTask *pClient);
PtPhoneLamp& operator=(const PtPhoneLamp& rhs);
//:Assignment operator
PtPhoneLamp();
//:Default constructor
virtual
~PtPhoneLamp();
//:Destructor
/* ============================ MANIPULATORS ============================== */
virtual PtStatus setMode(int mode);
//:Sets the indicator to one of its supported modes.
//!retcode: PT_SUCCESS - Success
//!retcode: PT_INVALID_ARGUMENT - The requested mode is not supported by this indicator
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
/* ============================ ACCESSORS ================================= */
virtual PtStatus getAssociatedPhoneButton(PtPhoneButton& rButton);
//:Returns a pointer to the PtPhoneButton object associated with this indicator.
//!param: (out) rpButton - The pointer to the associated button object
//!retcode: PT_SUCCESS - Success
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
virtual PtStatus getMode(int& rMode);
//:Sets <i>rMode</i> to the current mode for this indicator,
//!retcode: PT_SUCCESS - Success
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
virtual PtStatus getSupportedModes(int& rModeMask);
//:Sets <i>rModeMask</i> to all of the modes that are supported for this indicator.
/* ============================ INQUIRY =================================== */
/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
TaoClientTask *mpClient;
OsTime mTimeOut;
int mMode;
int mSupportedModes;
int mType;
PtPhoneButton *mpAssociatedButton;
void setAssociatedButton(PtPhoneButton* pButton);
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
OsProtectEventMgr *mpEventMgr;
};
/* ============================ INLINE METHODS ============================ */
#endif // _PtPhoneLamp_h_
|