Nla Sound Strips + Add Speaker
[blender.git] / source / gameengine / Network / NG_NetworkMessage.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 /** \file NG_NetworkMessage.h
31  *  \ingroup bgenet
32  *  \brief generic Network Message class
33  */
34 #ifndef NG_NETWORKMESSAGE_H
35 #define NG_NETWORKMESSAGE_H
36
37 #include "STR_HashedString.h"
38
39 #ifdef WITH_CXX_GUARDEDALLOC
40 #include "MEM_guardedalloc.h"
41 #endif
42
43 class NG_NetworkMessage
44 {
45         static int                      s_nextID;
46         int                                     m_uniqueMessageID;      // intern counting MessageID
47         unsigned int            m_ClientId;
48         int                                     m_refcount;
49
50         STR_String                      m_to;                   // receiver
51         STR_String                      m_from;                 // sender
52         STR_String                      m_subject;              // empty or propName
53         STR_String                      m_message;              // message or propValue
54
55 protected:
56         ~NG_NetworkMessage();
57
58 public:
59         NG_NetworkMessage(
60                 const STR_String& to,
61                 const STR_String& from,
62                 const STR_String& subject,
63                 const STR_String& body);
64
65         void AddRef() {
66                 m_refcount++;
67         }
68
69         // This is not nice code you should'nt need to resort to
70         // delete this.
71         void Release()
72         {
73                 if (! --m_refcount)
74                 {
75                         delete this;
76                 }
77         }
78
79         /**
80          * set the content of this message
81          */
82         void SetMessageText(const STR_String& msgtext) {
83                 m_message = msgtext;
84         }
85
86         /**
87          * get the (read-only) To part of this message
88          */
89         const STR_String& GetDestinationName() { return m_to;};
90
91         /**
92          * get the (read-only) From part of this message
93          */
94         const STR_String& GetSenderName() { return m_from;};
95
96         /**
97          * get the (read-only) Subject part of this message
98          */
99         const STR_String& GetSubject() { return m_subject;};
100
101         /**
102          * get the (read-only) Body part of this message
103          */
104         const STR_String& GetMessageText() {
105 //cout << "GetMessageText " << m_message << "\n";
106                 return m_message;
107         }
108         const STR_String& GetMessageText() const {
109 //cout << "GetMessageText " << m_message << "\n";
110                 return m_message;
111         }
112
113         /**
114          * Set the NetworkMessage sender identifier
115          */
116         void SetSender(unsigned int ClientId) {
117                 m_ClientId = ClientId;
118         }
119
120         /**
121          * Get the NetworkMessage sender identifier
122          */
123         unsigned int GetSender(void) {
124                 return m_ClientId;
125         }
126
127         /**
128           * get the unique Network Message ID
129           */
130         int GetMessageID() {
131                 return m_uniqueMessageID;
132         }
133         
134         
135 #ifdef WITH_CXX_GUARDEDALLOC
136 public:
137         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:NG_NetworkMessage"); }
138         void operator delete( void *mem ) { MEM_freeN(mem); }
139 #endif
140 };
141
142 #endif //NG_NETWORKMESSAGE_H
143