[#19232] (2.5) Correction of cmake for windows about audio (jack and openal)
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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  * NetworkGame_NetworkMessage generic Network Message class
29  */
30 #ifndef NG_NETWORKMESSAGE_H
31 #define NG_NETWORKMESSAGE_H
32
33 #include "STR_HashedString.h"
34
35 #ifdef WITH_CXX_GUARDEDALLOC
36 #include "MEM_guardedalloc.h"
37 #endif
38
39 class NG_NetworkMessage
40 {
41         static int                      s_nextID;
42         int                                     m_uniqueMessageID;      // intern counting MessageID
43         unsigned int            m_ClientId;
44         int                                     m_refcount;
45
46         STR_String                      m_to;                   // receiver
47         STR_String                      m_from;                 // sender
48         STR_String                      m_subject;              // empty or propName
49         STR_String                      m_message;              // message or propValue
50
51 protected:
52         ~NG_NetworkMessage();
53
54 public:
55         NG_NetworkMessage(
56                 const STR_String& to,
57                 const STR_String& from,
58                 const STR_String& subject,
59                 const STR_String& body);
60
61         void AddRef() {
62                 m_refcount++;
63         }
64
65         // This is not nice code you should'nt need to resort to
66         // delete this.
67         void Release()
68         {
69                 if (! --m_refcount)
70                 {
71                         delete this;
72                 }
73         }
74
75         /**
76          * set the content of this message
77          */
78         void SetMessageText(const STR_String& msgtext) {
79                 m_message = msgtext;
80         }
81
82         /**
83          * get the (read-only) To part of this message
84          */
85         const STR_String& GetDestinationName() { return m_to;};
86
87         /**
88          * get the (read-only) From part of this message
89          */
90         const STR_String& GetSenderName() { return m_from;};
91
92         /**
93          * get the (read-only) Subject part of this message
94          */
95         const STR_String& GetSubject() { return m_subject;};
96
97         /**
98          * get the (read-only) Body part of this message
99          */
100         const STR_String& GetMessageText() {
101 //cout << "GetMessageText " << m_message << "\n";
102                 return m_message;
103         }
104         const STR_String& GetMessageText() const {
105 //cout << "GetMessageText " << m_message << "\n";
106                 return m_message;
107         }
108
109         /**
110          * Set the NetworkMessage sender identifier
111          */
112         void SetSender(unsigned int ClientId) {
113                 m_ClientId = ClientId;
114         }
115
116         /**
117          * Get the NetworkMessage sender identifier
118          */
119         unsigned int GetSender(void) {
120                 return m_ClientId;
121         }
122
123         /**
124           * get the unique Network Message ID
125           */
126         int GetMessageID() {
127                 return m_uniqueMessageID;
128         }
129         
130         
131 #ifdef WITH_CXX_GUARDEDALLOC
132 public:
133         void *operator new( unsigned int num_bytes) { return MEM_mallocN(num_bytes, "GE:NG_NetworkMessage"); }
134         void operator delete( void *mem ) { MEM_freeN(mem); }
135 #endif
136 };
137
138 #endif //NG_NETWORKMESSAGE_H
139