File: LinePresenceMonitor.h

package info (click to toggle)
sipxtapi 3.3.0~test18%2Bdfsg.1-0.1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 55,892 kB
  • sloc: cpp: 435,979; ansic: 14,207; makefile: 2,491; java: 2,264; sh: 1,310; perl: 844; xml: 225; awk: 5
file content (121 lines) | stat: -rw-r--r-- 3,596 bytes parent folder | download
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
//
// 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 _LINEPRESENCEMONITOR_H_
#define _LINEPRESENCEMONITOR_H_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include <os/OsStatus.h>
#include <os/OsBSem.h>
#include <utl/UtlString.h>
#include <utl/UtlHashMap.h>
#include <net/StateChangeNotifier.h>
#include <net/SipDialogMonitor.h>
#include <cp/LinePresenceBase.h>
#include <cp/SipPresenceMonitor.h>


// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS

/**
 * A LinePresenceMonitor is an object that is used in the ACD-like clients to
 * receive the presence state change notifitcation from the dialog/presence
 * monitor. It has an option to use either local or remote dialog/presence
 * monitor. If using the remote monitor, subscription is sent out via XML-RPC.
 * 
 * This class is derived from StateChangeNotifier class.
 *
 */

class LinePresenceMonitor : public StateChangeNotifier
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

/* ============================ CREATORS ================================== */

   /// Constructor
   LinePresenceMonitor(int userAgentPort,     ///< user agent port
                       UtlString& domainName, ///< sipX domain name
                       UtlString& groupName,  ///< name of the group to be monitored
                       bool local,            ///< option for using local or remote monitor
                       Url& remoteServerUrl); ///< remote server url
  
   /// Destructor
   virtual ~LinePresenceMonitor();

/* ============================ MANIPULATORS ============================== */

/* ============================ ACCESSORS ================================= */

   /// Set the state value.
   virtual bool setStatus(const Url& aor, const Status value);

   /// Subscribe a line in the list
   OsStatus subscribe(LinePresenceBase* line);

   /// Unsubscribe a line from the list
   OsStatus unsubscribe(LinePresenceBase* line);
   
   /// Subscribe a list
   OsStatus subscribe(UtlSList& list);
   
   /// Unsubscribe a list
   OsStatus unsubscribe(UtlSList& list);

/* ============================ INQUIRY =================================== */

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:

   SipUserAgent* mpUserAgent;
   UtlString mGroupName;
   bool mLocal;
   
   SipDialogMonitor* mpDialogMonitor;
   SipPresenceMonitor* mpPresenceMonitor;

   SipDialogMgr mDialogManager;
   SipRefreshManager* mpRefreshMgr;
   SipSubscribeClient* mpSipSubscribeClient;
   
   Url mRemoteServer;

   UtlHashMap mSubscribeList;

   OsBSem mLock;                  /**<
                                    * semaphore used to ensure that there
                                    * is only one instance of this class
                                    */
                                    
   /// Disabled copy constructor
   LinePresenceMonitor(const LinePresenceMonitor& rLinePresenceMonitor);

   /// Disabled assignment operator
   LinePresenceMonitor& operator=(const LinePresenceMonitor& rhs); 
};

/* ============================ INLINE METHODS ============================ */

#endif  // _LINEPRESENCEMONITOR_H_