rebranch from 2.5
[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 class NG_NetworkMessage
36 {
37         static int                      s_nextID;
38         int                                     m_uniqueMessageID;      // intern counting MessageID
39         unsigned int            m_ClientId;
40         int                                     m_refcount;
41
42         STR_String                      m_to;                   // receiver
43         STR_String                      m_from;                 // sender
44         STR_String                      m_subject;              // empty or propName
45         STR_String                      m_message;              // message or propValue
46
47 protected:
48         ~NG_NetworkMessage();
49
50 public:
51         NG_NetworkMessage(
52                 const STR_String& to,
53                 const STR_String& from,
54                 const STR_String& subject,
55                 const STR_String& body);
56
57         void AddRef() {
58                 m_refcount++;
59         }
60
61         // This is not nice code you should'nt need to resort to
62         // delete this.
63         void Release()
64         {
65                 if (! --m_refcount)
66                 {
67                         delete this;
68                 }
69         }
70
71         /**
72          * set the content of this message
73          */
74         void SetMessageText(const STR_String& msgtext) {
75                 m_message = msgtext;
76         }
77
78         /**
79          * get the (read-only) To part of this message
80          */
81         const STR_String& GetDestinationName() { return m_to;};
82
83         /**
84          * get the (read-only) From part of this message
85          */
86         const STR_String& GetSenderName() { return m_from;};
87
88         /**
89          * get the (read-only) Subject part of this message
90          */
91         const STR_String& GetSubject() { return m_subject;};
92
93         /**
94          * get the (read-only) Body part of this message
95          */
96         const STR_String& GetMessageText() {
97 //cout << "GetMessageText " << m_message << "\n";
98                 return m_message;
99         }
100         const STR_String& GetMessageText() const {
101 //cout << "GetMessageText " << m_message << "\n";
102                 return m_message;
103         }
104
105         /**
106          * Set the NetworkMessage sender identifier
107          */
108         void SetSender(unsigned int ClientId) {
109                 m_ClientId = ClientId;
110         }
111
112         /**
113          * Get the NetworkMessage sender identifier
114          */
115         unsigned int GetSender(void) {
116                 return m_ClientId;
117         }
118
119         /**
120           * get the unique Network Message ID
121           */
122         int GetMessageID() {
123                 return m_uniqueMessageID;
124         }
125 };
126
127 #endif //NG_NETWORKMESSAGE_H
128