1 | /* |
---|
2 | orxonox - the future of 3D-vertical-scrollers |
---|
3 | |
---|
4 | Copyright (C) 2004 orx |
---|
5 | |
---|
6 | This program is free software; you can redistribute it and/or modify |
---|
7 | it under the terms of the GNU General Public License as published by |
---|
8 | the Free Software Foundation; either version 2, or (at your option) |
---|
9 | any later version. |
---|
10 | |
---|
11 | ### File Specific: |
---|
12 | main-programmer: Christoph Renner |
---|
13 | co-programmer: ... |
---|
14 | */ |
---|
15 | |
---|
16 | //#define DEBUG_SPECIAL_MODULE DEBUG_MODULE_ |
---|
17 | |
---|
18 | #include "message_manager.h" |
---|
19 | |
---|
20 | #include "network_stream.h" |
---|
21 | #include "shared_network_data.h" |
---|
22 | #include "converter.h" |
---|
23 | #include <cassert> |
---|
24 | |
---|
25 | |
---|
26 | |
---|
27 | MessageManager* MessageManager::singletonRef = NULL; |
---|
28 | |
---|
29 | |
---|
30 | /** |
---|
31 | * standard constructor |
---|
32 | */ |
---|
33 | MessageManager::MessageManager () |
---|
34 | { |
---|
35 | this->setClassID( CL_MESSAGE_MANAGER, "MessageManager" ); |
---|
36 | newNumber = 1; |
---|
37 | setSynchronized( true ); |
---|
38 | } |
---|
39 | |
---|
40 | |
---|
41 | /** |
---|
42 | * standard deconstructor |
---|
43 | */ |
---|
44 | MessageManager::~MessageManager () |
---|
45 | { |
---|
46 | for ( MessageQueue::iterator it = outgoingMessageQueue.begin(); it != outgoingMessageQueue.end(); it++ ) |
---|
47 | { |
---|
48 | for ( std::list<NetworkMessage>::iterator it2 = it->second.messages.begin(); it2 != it->second.messages.end(); it2++ ) |
---|
49 | { |
---|
50 | if ( it2->data ) |
---|
51 | { |
---|
52 | delete [] it2->data; |
---|
53 | it2->data = NULL; |
---|
54 | } |
---|
55 | } |
---|
56 | |
---|
57 | it->second.messages.clear(); |
---|
58 | it->second.toAck.clear(); |
---|
59 | } |
---|
60 | |
---|
61 | outgoingMessageQueue.clear(); |
---|
62 | |
---|
63 | this->messageHandlerMap.clear(); |
---|
64 | |
---|
65 | MessageManager::singletonRef = NULL; |
---|
66 | } |
---|
67 | |
---|
68 | /** |
---|
69 | * get the diff to last acked state of userId |
---|
70 | * |
---|
71 | * this class does not use the normal SynchronizeableVars for zynchronisation. instead |
---|
72 | * it defines its own protocol |
---|
73 | * |
---|
74 | * @param userId user to create diff for |
---|
75 | * @param data buffer to copy diff in |
---|
76 | * @param maxLength max bytes to copy into data |
---|
77 | * @param stateId id of current state |
---|
78 | * @param fromStateId the reference state for the delta state |
---|
79 | * @param priorityTH tells getStateDiff to not send element with priority \< priorityTH |
---|
80 | * @return n bytes copied into data |
---|
81 | */ |
---|
82 | int MessageManager::getStateDiff( int userId, byte * data, int maxLength, int stateId, int fromStateId, int priorityTH ) |
---|
83 | { |
---|
84 | int i = 0; |
---|
85 | int n; |
---|
86 | |
---|
87 | n = Converter::intToByteArray( outgoingMessageQueue[userId].toAck.size(), data + i, maxLength ); |
---|
88 | i += n; |
---|
89 | assert( n == INTSIZE ); |
---|
90 | |
---|
91 | for ( std::list<int>::iterator it = outgoingMessageQueue[userId].toAck.begin(); it != outgoingMessageQueue[userId].toAck.end(); it++) |
---|
92 | { |
---|
93 | n = Converter::intToByteArray( *it, data + i, maxLength ); |
---|
94 | i += n; |
---|
95 | assert( n == INTSIZE ); |
---|
96 | } |
---|
97 | |
---|
98 | outgoingMessageQueue[userId].toAck.clear(); |
---|
99 | |
---|
100 | n = Converter::intToByteArray( outgoingMessageQueue[userId].messages.size(), data + i, maxLength ); |
---|
101 | i += n; |
---|
102 | assert( n == INTSIZE ); |
---|
103 | |
---|
104 | for ( std::list<NetworkMessage>::iterator it = outgoingMessageQueue[userId].messages.begin(); it != outgoingMessageQueue[userId].messages.end(); it++ ) |
---|
105 | { |
---|
106 | n = Converter::intToByteArray( it->length, data + i, maxLength ); |
---|
107 | i += n; |
---|
108 | assert( n == INTSIZE ); |
---|
109 | |
---|
110 | n = Converter::intToByteArray( it->number, data + i, maxLength ); |
---|
111 | i += n; |
---|
112 | assert( n == INTSIZE ); |
---|
113 | |
---|
114 | n = Converter::intToByteArray( it->messageType, data + i, maxLength ); |
---|
115 | i += n; |
---|
116 | assert( n == INTSIZE ); |
---|
117 | |
---|
118 | assert( i + it->length <= maxLength ); |
---|
119 | memcpy( data + i, it->data, it->length ); |
---|
120 | i += it->length; |
---|
121 | } |
---|
122 | |
---|
123 | return i; |
---|
124 | } |
---|
125 | |
---|
126 | /** |
---|
127 | * sets a new state out of a diff created on another host |
---|
128 | * @param userId hostId of user who send me that diff |
---|
129 | * @param data pointer to diff |
---|
130 | * @param length length of diff |
---|
131 | * @param stateId id of current state |
---|
132 | * @param fromStateId id of the base state id |
---|
133 | * @return number bytes read |
---|
134 | * @todo check for permissions |
---|
135 | */ |
---|
136 | int MessageManager::setStateDiff( int userId, byte * data, int length, int stateId, int fromStateId ) |
---|
137 | { |
---|
138 | int i = 0; |
---|
139 | int n; |
---|
140 | |
---|
141 | int nAcks; |
---|
142 | |
---|
143 | |
---|
144 | assert( i + INTSIZE <= length ); |
---|
145 | n = Converter::byteArrayToInt( data + i, &nAcks ); |
---|
146 | assert( n == INTSIZE ); |
---|
147 | i += n; |
---|
148 | |
---|
149 | std::list<int> acks; |
---|
150 | |
---|
151 | int number; |
---|
152 | |
---|
153 | for ( int j = 0; j < nAcks; j++ ) |
---|
154 | { |
---|
155 | assert( i + INTSIZE <= length ); |
---|
156 | n = Converter::byteArrayToInt( data + i, &number ); |
---|
157 | assert( n == INTSIZE ); |
---|
158 | i += n; |
---|
159 | |
---|
160 | acks.push_back( number ); |
---|
161 | } |
---|
162 | |
---|
163 | int nMessages; |
---|
164 | |
---|
165 | assert( i + INTSIZE <= length ); |
---|
166 | n = Converter::byteArrayToInt( data + i, &nMessages ); |
---|
167 | assert( n == INTSIZE ); |
---|
168 | i += n; |
---|
169 | |
---|
170 | int messageLength, messageType; |
---|
171 | |
---|
172 | // now go through all messages |
---|
173 | for ( int j = 0; j < nMessages; j++ ) |
---|
174 | { |
---|
175 | assert( i + INTSIZE <= length ); |
---|
176 | n = Converter::byteArrayToInt( data + i, &messageLength ); |
---|
177 | assert( n == INTSIZE ); |
---|
178 | i += n; |
---|
179 | |
---|
180 | assert( i + INTSIZE <= length ); |
---|
181 | n = Converter::byteArrayToInt( data + i, &number ); |
---|
182 | assert( n == INTSIZE ); |
---|
183 | i += n; |
---|
184 | |
---|
185 | assert( i + INTSIZE <= length ); |
---|
186 | n = Converter::byteArrayToInt( data + i, &messageType ); |
---|
187 | assert( n == INTSIZE ); |
---|
188 | i += n; |
---|
189 | |
---|
190 | if ( number > 0 ) |
---|
191 | outgoingMessageQueue[userId].toAck.push_back( number ); |
---|
192 | |
---|
193 | assert( i + messageLength <= length ); |
---|
194 | // make sure there is a message handler for this message type |
---|
195 | assert( messageHandlerMap.find( (MessageType)messageType ) != messageHandlerMap.end() ); |
---|
196 | |
---|
197 | |
---|
198 | if ( std::find( outgoingMessageQueue[userId].recievedMessages.begin(), outgoingMessageQueue[userId].recievedMessages.end(), number ) == |
---|
199 | outgoingMessageQueue[userId].recievedMessages.end() ) |
---|
200 | { |
---|
201 | if ( !(*(messageHandlerMap[(MessageType)messageType].cb))( (MessageType)messageType, data + i, messageLength, messageHandlerMap[(MessageType)messageType].someData, userId ) ) |
---|
202 | { |
---|
203 | NetworkMessage msg; |
---|
204 | |
---|
205 | msg.data = new byte[messageLength]; |
---|
206 | memcpy( msg.data, data + i, messageLength ); |
---|
207 | msg.length = messageLength; |
---|
208 | msg.messageType = (MessageType)messageType; |
---|
209 | msg.number = userId; |
---|
210 | |
---|
211 | incomingMessageQueue.push_back( msg ); |
---|
212 | } |
---|
213 | outgoingMessageQueue[userId].recievedMessages.push_back( number ); |
---|
214 | } |
---|
215 | i += messageLength; |
---|
216 | } |
---|
217 | |
---|
218 | |
---|
219 | //TODO maybe handle incomingMessage in tick function. else local messages will not be handled if no clients are connected |
---|
220 | for ( std::list<NetworkMessage>::iterator it = incomingMessageQueue.begin(); it != incomingMessageQueue.end(); ) |
---|
221 | { |
---|
222 | if ( (*(messageHandlerMap[it->messageType].cb))( it->messageType, it->data, it->length, messageHandlerMap[it->messageType].someData, it->number ) ) |
---|
223 | { |
---|
224 | std::list<NetworkMessage>::iterator delIt = it; |
---|
225 | if ( it->data ) |
---|
226 | delete it->data; |
---|
227 | it++; |
---|
228 | incomingMessageQueue.erase( delIt ); |
---|
229 | continue; |
---|
230 | } |
---|
231 | it++; |
---|
232 | } |
---|
233 | |
---|
234 | //walk throu message queue and remove acked messages |
---|
235 | for ( std::list<NetworkMessage>::iterator it = outgoingMessageQueue[userId].messages.begin(); it != outgoingMessageQueue[userId].messages.end(); ) |
---|
236 | { |
---|
237 | if ( std::find( acks.begin(), acks.end(), it->number) != acks.end() ) |
---|
238 | { |
---|
239 | std::list<NetworkMessage>::iterator delIt = it; |
---|
240 | it++; |
---|
241 | outgoingMessageQueue[userId].messages.erase( delIt ); |
---|
242 | continue; |
---|
243 | } |
---|
244 | it++; |
---|
245 | } |
---|
246 | |
---|
247 | //TODO find bether way. maybe with timestamp |
---|
248 | if ( outgoingMessageQueue[userId].recievedMessages.size() > 1000 ) |
---|
249 | { |
---|
250 | for ( int j = 0; j < outgoingMessageQueue[userId].recievedMessages.size() - 1000; j++ ) |
---|
251 | outgoingMessageQueue[userId].recievedMessages.erase( outgoingMessageQueue[userId].recievedMessages.begin() ); |
---|
252 | } |
---|
253 | |
---|
254 | return i; |
---|
255 | } |
---|
256 | |
---|
257 | |
---|
258 | |
---|
259 | /** |
---|
260 | * clean up memory reserved for user |
---|
261 | * @param userId userid |
---|
262 | */ |
---|
263 | void MessageManager::cleanUpUser( int userId ) |
---|
264 | { |
---|
265 | if ( outgoingMessageQueue.find( userId ) == outgoingMessageQueue.end() ) |
---|
266 | return; |
---|
267 | |
---|
268 | for ( std::list<NetworkMessage>::iterator it = outgoingMessageQueue[userId].messages.begin(); it != outgoingMessageQueue[userId].messages.end(); it++ ) |
---|
269 | { |
---|
270 | if ( it->data ) |
---|
271 | delete it->data; |
---|
272 | it->data = NULL; |
---|
273 | } |
---|
274 | |
---|
275 | outgoingMessageQueue[userId].toAck.clear(); |
---|
276 | |
---|
277 | outgoingMessageQueue.erase( userId ); |
---|
278 | } |
---|
279 | |
---|
280 | /** |
---|
281 | * registers function to handle messages with id messageType. someData is passed to callbackfuntion |
---|
282 | * @param messageType message id to handle |
---|
283 | * @param cb function pointer to callback function |
---|
284 | * @param someData this pointer is passed to callback function without modification |
---|
285 | * @return true on success |
---|
286 | */ |
---|
287 | bool MessageManager::registerMessageHandler( MessageType messageType, MessageCallback cb, void * someData ) |
---|
288 | { |
---|
289 | MessageHandler messageHandler; |
---|
290 | |
---|
291 | messageHandler.cb = cb; |
---|
292 | messageHandler.messageType = messageType; |
---|
293 | messageHandler.someData = someData; |
---|
294 | |
---|
295 | messageHandlerMap[messageType] = messageHandler; |
---|
296 | |
---|
297 | return true; |
---|
298 | } |
---|
299 | |
---|
300 | /** |
---|
301 | * initializes buffers for user |
---|
302 | * @param userId userId |
---|
303 | */ |
---|
304 | void MessageManager::initUser( int userId ) |
---|
305 | { |
---|
306 | // just do something so map creates a new entry |
---|
307 | outgoingMessageQueue[userId].toAck.clear(); |
---|
308 | //assert( outgoingMessageQueue[userId].messages.size() == 0 ); |
---|
309 | } |
---|
310 | |
---|
311 | /** |
---|
312 | * send a message to one or more clients |
---|
313 | * recieverType: |
---|
314 | * RT_ALL send to all users. reciever is ignored |
---|
315 | * RT_USER send only to reciever |
---|
316 | * RT_NOT_USER send to all but reciever |
---|
317 | * |
---|
318 | * @param messageType message id |
---|
319 | * @param data pointer to data |
---|
320 | * @param dataLength length of data |
---|
321 | * @param recieverType type of the receiver |
---|
322 | * @param reciever the userId of the receiver if needed (depends on the ReceiverType) |
---|
323 | */ |
---|
324 | void MessageManager::sendMessage( MessageType messageType, byte * data, int dataLength, RecieverType recieverType, int reciever, MessagePriority messagePriority ) |
---|
325 | { |
---|
326 | // go through all outgoing message queues and add the message if its appropriate |
---|
327 | for ( MessageQueue::iterator it = this->outgoingMessageQueue.begin(); it != this->outgoingMessageQueue.end(); it++ ) |
---|
328 | { |
---|
329 | |
---|
330 | // relay server special handling |
---|
331 | if( SharedNetworkData::getInstance()->isMasterServer() && SharedNetworkData::getInstance()->isUserProxyServerActive(it->first)) |
---|
332 | { |
---|
333 | NetworkMessage msg; |
---|
334 | |
---|
335 | msg.data = new byte[dataLength]; |
---|
336 | memcpy( msg.data, data, dataLength ); |
---|
337 | msg.length = dataLength; |
---|
338 | msg.messageType = messageType; |
---|
339 | msg.number = this->newNumber++; |
---|
340 | msg.priority = messagePriority; |
---|
341 | |
---|
342 | it->second.messages.push_back( msg ); |
---|
343 | } |
---|
344 | // check for every node if the message is for it also |
---|
345 | else if ( |
---|
346 | recieverType == RT_ALL_ME || |
---|
347 | recieverType == RT_ALL_BUT_ME || |
---|
348 | recieverType == RT_USER && it->first == reciever || |
---|
349 | recieverType == RT_NOT_USER && it->first != reciever || |
---|
350 | recieverType == RT_SERVER && getNetworkStream()->isUserMasterServer( it->first ) || |
---|
351 | recieverType == RT_SERVER && getNetworkStream()->isUserProxyServerActive( it->first ) |
---|
352 | ) |
---|
353 | { |
---|
354 | NetworkMessage msg; |
---|
355 | |
---|
356 | msg.data = new byte[dataLength]; |
---|
357 | memcpy( msg.data, data, dataLength ); |
---|
358 | msg.length = dataLength; |
---|
359 | msg.messageType = messageType; |
---|
360 | msg.number = this->newNumber++; |
---|
361 | msg.priority = messagePriority; |
---|
362 | |
---|
363 | it->second.messages.push_back( msg ); |
---|
364 | } |
---|
365 | |
---|
366 | |
---|
367 | } |
---|
368 | |
---|
369 | |
---|
370 | // if the message is also for myself, handle it here |
---|
371 | if ( recieverType == RT_ALL_ME ) |
---|
372 | { |
---|
373 | NetworkMessage msg; |
---|
374 | |
---|
375 | msg.data = new byte[dataLength]; |
---|
376 | memcpy( msg.data, data, dataLength ); |
---|
377 | msg.length = dataLength; |
---|
378 | msg.messageType = messageType; |
---|
379 | msg.number = SharedNetworkData::getInstance()->getHostID(); |
---|
380 | msg.priority = messagePriority; |
---|
381 | |
---|
382 | incomingMessageQueue.push_back( msg ); |
---|
383 | } |
---|
384 | } |
---|
385 | |
---|
386 | |
---|