sipxmediaadapterlib  Version 3.3
MiStringNotf.h
Go to the documentation of this file.
1 //
2 // Copyright (C) 2008-2011 SIPez LLC. All rights reserved.
3 // Licensed to SIPfoundry under a Contributor Agreement.
4 //
5 // Copyright (C) 2008 SIPfoundry Inc.
6 // Licensed by SIPfoundry under the LGPL license.
7 //
8 // $$
10 
11 // Author: Daniel Petrie <dpetrie AT SIPez DOT com>
12 
13 #ifndef _MiStringNotf_h_
14 #define _MiStringNotf_h_
15 
16 // SYSTEM INCLUDES
17 
18 // APPLICATION INCLUDES
19 #include <os/OsMsg.h>
20 #include <utl/UtlString.h>
21 #include <mi/MiNotification.h>
22 
23 // DEFINES
24 // MACROS
25 // EXTERNAL FUNCTIONS
26 // EXTERNAL VARIABLES
27 // CONSTANTS
28 // STRUCTS
29 // TYPEDEFS
30 // FORWARD DECLARATIONS
31 
34 {
35 /* //////////////////////////// PUBLIC //////////////////////////////////// */
36 public:
37 
38 /* ============================ CREATORS ================================== */
40 
41 
43  MiStringNotf(NotfType msgType,
44  const UtlString& sourceId,
45  const UtlString& value,
46  int connectionId = INVALID_CONNECTION_ID,
47  int streamId = -1);
48 
50  MiStringNotf(const MiStringNotf& rNotf);
51 
53  virtual OsMsg* createCopy() const;
54 
56  virtual ~MiStringNotf();
57 
59 
60 /* ============================ MANIPULATORS ============================== */
62 
63 
65  MiStringNotf& operator=(const MiStringNotf& rhs);
66 
68 
69 /* ============================ ACCESSORS ================================= */
71 
72 
74  void setValue(const UtlString& value);
75 
77  void getValue(UtlString& value) const;
78 
80 
81 /* ============================ INQUIRY =================================== */
83 
84 
86 
87 /* //////////////////////////// PROTECTED ///////////////////////////////// */
88 protected:
89 
90 /* //////////////////////////// PRIVATE /////////////////////////////////// */
91 private:
92  UtlString mValue;
93 };
94 
95 /* ============================ INLINE METHODS ============================ */
96 
97 #endif // _MiStringNotf_h_
NotfType
Media notification message types.
Definition: MiNotification.h:48
virtual ~MiStringNotf()
Destructor.
Definition: MiStringNotf.cpp:49
void getValue(UtlString &value) const
Get the value this notification reports.
Definition: MiStringNotf.cpp:76
Message notification class used to communicate media notification events.
Definition: MiNotification.h:42
MiStringNotf & operator=(const MiStringNotf &rhs)
Assignment operator.
Definition: MiStringNotf.cpp:57
void setValue(const UtlString &value)
Set the value this notification reports.
Definition: MiStringNotf.cpp:69
static const int INVALID_CONNECTION_ID
Connection ID that indicates invalid connection or no connection.
Definition: MiNotification.h:85
virtual OsMsg * createCopy() const
Create a copy of this msg object (which may be of a derived type)
Definition: MiStringNotf.cpp:44
UtlString mValue
Reported value.
Definition: MiStringNotf.h:92
Message notification class used to communicate abstract integer value.
Definition: MiStringNotf.h:33
MiStringNotf(NotfType msgType, const UtlString &sourceId, const UtlString &value, int connectionId=INVALID_CONNECTION_ID, int streamId=-1)
Constructor.
Definition: MiStringNotf.cpp:28