Initial revision
[blender.git] / source / gameengine / Network / NG_NetworkMessage.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL 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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  * NetworkGame_NetworkMessage generic Network Message class
32  */
33 #ifndef NG_NETWORKMESSAGE_H
34 #define NG_NETWORKMESSAGE_H
35
36 #include "STR_HashedString.h"
37
38 class NG_NetworkMessage
39 {
40         static int                      s_nextID;
41         int                                     m_uniqueMessageID;      // intern counting MessageID
42         unsigned int            m_ClientId;
43         int                                     m_refcount;
44
45         STR_String                      m_to;                   // receiver
46         STR_String                      m_from;                 // sender
47         STR_String                      m_subject;              // empty or propName
48         STR_String                      m_message;              // message or propValue
49
50 protected:
51         ~NG_NetworkMessage();
52
53 public:
54         NG_NetworkMessage(
55                 const STR_String& to,
56                 const STR_String& from,
57                 const STR_String& subject,
58                 const STR_String& body);
59
60         void AddRef() {
61                 m_refcount++;
62         }
63
64         // This is not nice code you should'nt need to resort to
65         // delete this.
66         void Release()
67         {
68                 if (! --m_refcount)
69                 {
70                         delete this;
71                 }
72         }
73
74         /**
75          * set the content of this message
76          */
77         void SetMessageText(const STR_String& msgtext) {
78                 m_message = msgtext;
79         }
80
81         /**
82          * get the (read-only) To part of this message
83          */
84         const STR_String& GetDestinationName() { return m_to;};
85
86         /**
87          * get the (read-only) From part of this message
88          */
89         const STR_String& GetSenderName() { return m_from;};
90
91         /**
92          * get the (read-only) Subject part of this message
93          */
94         const STR_String& GetSubject() { return m_subject;};
95
96         /**
97          * get the (read-only) Body part of this message
98          */
99         const STR_String& GetMessageText() {
100 //cout << "GetMessageText " << m_message << "\n";
101                 return m_message;
102         }
103         const STR_String& GetMessageText() const {
104 //cout << "GetMessageText " << m_message << "\n";
105                 return m_message;
106         }
107
108         /**
109          * Set the NetworkMessage sender identifier
110          */
111         void SetSender(unsigned int ClientId) {
112                 m_ClientId = ClientId;
113         }
114
115         /**
116          * Get the NetworkMessage sender identifier
117          */
118         unsigned int GetSender(void) {
119                 return m_ClientId;
120         }
121
122         /**
123           * get the unique Network Message ID
124           */
125         int GetMessageID() {
126                 return m_uniqueMessageID;
127         }
128 };
129
130 #endif //NG_NETWORKMESSAGE_H