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