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
|
//
// 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 _LinePresenceBase_h_
#define _LinePresenceBase_h_
// SYSTEM INCLUDES
// APPLICATION INCLUDES
// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class Url;
/**
* The LinePresenceBase class provides a set of pure virtual interfaces which
* allow for the setting and retrieval line presence and state information.
*/
class LinePresenceBase {
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
/**
* Line Presence state type enumerations. These are used collectively to
* represent the possible states of PRESENT, (NOT)PRESENT, ON_HOOK
* and (NOT)ON_HOOK.
*/
enum ePresenceStateType {
PRESENT = 1, /**< present state */
ON_HOOK = 2, /**< on/off hook state */
SIGNED_IN = 4 /**< ACD SIGNED-IN state */
};
/* ============================ CREATORS ================================== */
/**
* Default constructor
*/
LinePresenceBase(void) {}
/**
* Destructor
*/
virtual ~LinePresenceBase() {}
/* ============================ MANIPULATORS ============================== */
/**
* Update the presence / line state for this line.
*
* @param type The type of presence state to be updated.
*
* @param state The state value to be updated.
*/
virtual void updateState(ePresenceStateType type, bool state) = 0;
/* ============================ ACCESSORS ================================= */
/**
* Return the AOR for this line.
*/
virtual Url* getUri(void) = 0;
/**
* Return the presence / line state information for this line.
*/
virtual bool getState(ePresenceStateType type) = 0;
/* ============================ INQUIRY =================================== */
/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
};
#endif // _LinePresenceBase_h_
|
