[1505] | 1 | /* |
---|
| 2 | * ORXONOX - the hottest 3D action shooter ever to exist |
---|
| 3 | * > www.orxonox.net < |
---|
| 4 | * |
---|
| 5 | * |
---|
| 6 | * License notice: |
---|
| 7 | * |
---|
| 8 | * This program is free software; you can redistribute it and/or |
---|
| 9 | * modify it under the terms of the GNU General Public License |
---|
| 10 | * as published by the Free Software Foundation; either version 2 |
---|
| 11 | * of the License, or (at your option) any later version. |
---|
| 12 | * |
---|
| 13 | * This program is distributed in the hope that it will be useful, |
---|
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 16 | * GNU General Public License for more details. |
---|
| 17 | * |
---|
| 18 | * You should have received a copy of the GNU General Public License |
---|
| 19 | * along with this program; if not, write to the Free Software |
---|
| 20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
---|
| 21 | * |
---|
| 22 | * Author: |
---|
| 23 | * Dumeni Manatschal, (C) 2007 |
---|
| 24 | * Oliver Scheuss, (C) 2007 |
---|
| 25 | * Co-authors: |
---|
| 26 | * ... |
---|
| 27 | * |
---|
| 28 | */ |
---|
| 29 | |
---|
| 30 | // |
---|
| 31 | // C++ Implementation: synchronisable |
---|
| 32 | // |
---|
| 33 | // Description: |
---|
| 34 | // |
---|
| 35 | // |
---|
| 36 | // Author: Dumeni, Oliver Scheuss, (C) 2007 |
---|
| 37 | // |
---|
| 38 | // Copyright: See COPYING file that comes with this distribution |
---|
| 39 | // |
---|
| 40 | |
---|
| 41 | #include "Synchronisable.h" |
---|
| 42 | |
---|
[1837] | 43 | #include <cstring> |
---|
[2011] | 44 | #include <string> |
---|
[1505] | 45 | #include <iostream> |
---|
[1735] | 46 | #include <assert.h> |
---|
[1505] | 47 | |
---|
| 48 | #include "core/CoreIncludes.h" |
---|
[1735] | 49 | #include "core/BaseObject.h" |
---|
[1534] | 50 | // #include "core/Identifier.h" |
---|
[1505] | 51 | |
---|
| 52 | namespace network |
---|
| 53 | { |
---|
[1639] | 54 | |
---|
[1940] | 55 | |
---|
[1907] | 56 | std::map<unsigned int, Synchronisable *> Synchronisable::objectMap_; |
---|
| 57 | std::queue<unsigned int> Synchronisable::deletedObjects_; |
---|
[1639] | 58 | |
---|
[1505] | 59 | int Synchronisable::state_=0x1; // detemines wheter we are server (default) or client |
---|
[1639] | 60 | |
---|
[1505] | 61 | /** |
---|
| 62 | * Constructor: |
---|
[1907] | 63 | * Initializes all Variables and sets the right objectID |
---|
[1505] | 64 | */ |
---|
[2034] | 65 | Synchronisable::Synchronisable(orxonox::BaseObject* creator){ |
---|
[1505] | 66 | RegisterRootObject(Synchronisable); |
---|
[1907] | 67 | static uint32_t idCounter=0; |
---|
[1751] | 68 | objectFrequency_=1; |
---|
[1907] | 69 | objectMode_=0x1; // by default do not send data to server |
---|
[1505] | 70 | objectID=idCounter++; |
---|
[1940] | 71 | classID = (unsigned int)-1; |
---|
[1505] | 72 | syncList = new std::list<synchronisableVariable *>; |
---|
[2034] | 73 | |
---|
| 74 | this->creatorID = OBJECTID_UNKNOWN; |
---|
| 75 | |
---|
| 76 | searchcreatorID: |
---|
| 77 | if (creator) |
---|
| 78 | { |
---|
| 79 | if (creator->isA(Class(Synchronisable))) |
---|
| 80 | { |
---|
| 81 | Synchronisable* synchronisable_creator = dynamic_cast<Synchronisable*>(creator); |
---|
| 82 | this->creatorID = synchronisable_creator->getObjectID(); |
---|
| 83 | } |
---|
| 84 | else if (creator != creator->getCreator()) |
---|
| 85 | { |
---|
| 86 | creator = creator->getCreator(); |
---|
| 87 | goto searchcreatorID; |
---|
| 88 | } |
---|
| 89 | } |
---|
[1505] | 90 | } |
---|
| 91 | |
---|
[1907] | 92 | /** |
---|
[1940] | 93 | * Destructor: |
---|
[1907] | 94 | * Delete all callback objects and remove objectID from the objectMap_ |
---|
| 95 | */ |
---|
[1505] | 96 | Synchronisable::~Synchronisable(){ |
---|
[1534] | 97 | // delete callback function objects |
---|
[1907] | 98 | if(!orxonox::Identifier::isCreatingHierarchy()){ |
---|
[1534] | 99 | for(std::list<synchronisableVariable *>::iterator it = syncList->begin(); it!=syncList->end(); it++) |
---|
| 100 | delete (*it)->callback; |
---|
[1989] | 101 | if (this->objectMode_ != 0x0) |
---|
| 102 | deletedObjects_.push(objectID); |
---|
[1907] | 103 | // COUT(3) << "destruct synchronisable +++" << objectID << " | " << classID << std::endl; |
---|
| 104 | // COUT(3) << " bump ---" << objectID << " | " << &objectMap_ << std::endl; |
---|
| 105 | // assert(objectMap_[objectID]->objectID==objectID); |
---|
| 106 | // objectMap_.erase(objectID); |
---|
| 107 | } |
---|
[1505] | 108 | } |
---|
[1639] | 109 | |
---|
[1907] | 110 | /** |
---|
| 111 | * This function gets called after all neccessary data has been passed to the object |
---|
| 112 | * Overload this function and recall the create function of the parent class |
---|
| 113 | * @return true/false |
---|
| 114 | */ |
---|
[1505] | 115 | bool Synchronisable::create(){ |
---|
| 116 | this->classID = this->getIdentifier()->getNetworkID(); |
---|
[1907] | 117 | // COUT(4) << "creating synchronisable: setting classid from " << this->getIdentifier()->getName() << " to: " << classID << std::endl; |
---|
[1940] | 118 | |
---|
[1907] | 119 | // COUT(3) << "construct synchronisable +++" << objectID << " | " << classID << std::endl; |
---|
| 120 | // objectMap_[objectID]=this; |
---|
| 121 | // assert(objectMap_[objectID]==this); |
---|
| 122 | // assert(objectMap_[objectID]->objectID==objectID); |
---|
[1505] | 123 | return true; |
---|
| 124 | } |
---|
[1639] | 125 | |
---|
[1856] | 126 | |
---|
[1907] | 127 | /** |
---|
| 128 | * This function sets the internal mode for synchronisation |
---|
| 129 | * @param b true if this object is located on a client or on a server |
---|
| 130 | */ |
---|
[1505] | 131 | void Synchronisable::setClient(bool b){ |
---|
| 132 | if(b) // client |
---|
| 133 | state_=0x2; |
---|
| 134 | else // server |
---|
| 135 | state_=0x1; |
---|
| 136 | } |
---|
[1856] | 137 | |
---|
[1907] | 138 | /** |
---|
| 139 | * This function fabricated a new synchrnisable (and children of it), sets calls updateData and create |
---|
| 140 | * After calling this function the mem pointer will be increased by the size of the needed data |
---|
| 141 | * @param mem pointer to where the appropriate data is located |
---|
| 142 | * @param mode defines the mode, how the data should be loaded |
---|
| 143 | * @return pointer to the newly created synchronisable |
---|
| 144 | */ |
---|
| 145 | Synchronisable *Synchronisable::fabricate(uint8_t*& mem, int mode) |
---|
[1735] | 146 | { |
---|
[1907] | 147 | synchronisableHeader *header = (synchronisableHeader *)mem; |
---|
[1856] | 148 | |
---|
[1907] | 149 | COUT(3) << "fabricating object with id: " << header->objectID << std::endl; |
---|
[1856] | 150 | |
---|
[1907] | 151 | orxonox::Identifier* id = ClassByID(header->classID); |
---|
| 152 | assert(id); |
---|
[2034] | 153 | orxonox::BaseObject* creator = 0; |
---|
| 154 | if (header->creatorID != OBJECTID_UNKNOWN) |
---|
| 155 | { |
---|
| 156 | Synchronisable* synchronisable_creator = Synchronisable::getSynchronisable(header->creatorID); |
---|
| 157 | if (!synchronisable_creator) |
---|
| 158 | return 0; |
---|
| 159 | else |
---|
| 160 | creator = dynamic_cast<orxonox::BaseObject*>(synchronisable_creator); |
---|
| 161 | } |
---|
| 162 | orxonox::BaseObject *bo = id->fabricate(creator); |
---|
| 163 | assert(bo); |
---|
[1735] | 164 | Synchronisable *no = dynamic_cast<Synchronisable *>(bo); |
---|
| 165 | assert(no); |
---|
[1907] | 166 | no->objectID=header->objectID; |
---|
[2033] | 167 | no->creatorID=header->creatorID; //TODO: remove this |
---|
[1907] | 168 | no->classID=header->classID; |
---|
[1735] | 169 | COUT(3) << "fabricate objectID: " << no->objectID << " classID: " << no->classID << std::endl; |
---|
| 170 | // update data and create object/entity... |
---|
[1945] | 171 | bool b = no->updateData(mem, mode, true); |
---|
[2031] | 172 | // assert(b); |
---|
| 173 | if (b) |
---|
| 174 | { |
---|
| 175 | b = no->create(); |
---|
| 176 | assert(b); |
---|
| 177 | } |
---|
[1907] | 178 | return no; |
---|
| 179 | } |
---|
| 180 | |
---|
[1940] | 181 | |
---|
[1907] | 182 | /** |
---|
| 183 | * Finds and deletes the Synchronisable with the appropriate objectID |
---|
| 184 | * @param objectID objectID of the Synchronisable |
---|
| 185 | * @return true/false |
---|
| 186 | */ |
---|
| 187 | bool Synchronisable::deleteObject(unsigned int objectID){ |
---|
| 188 | // assert(getSynchronisable(objectID)); |
---|
| 189 | if(!getSynchronisable(objectID)) |
---|
[1735] | 190 | return false; |
---|
[1907] | 191 | assert(getSynchronisable(objectID)->objectID==objectID); |
---|
| 192 | // delete objectMap_[objectID]; |
---|
| 193 | Synchronisable *s = getSynchronisable(objectID); |
---|
| 194 | if(s) |
---|
| 195 | delete s; |
---|
| 196 | else |
---|
[1735] | 197 | return false; |
---|
| 198 | return true; |
---|
| 199 | } |
---|
[1940] | 200 | |
---|
[1907] | 201 | /** |
---|
| 202 | * This function looks up the objectID in the objectMap_ and returns a pointer to the right Synchronisable |
---|
| 203 | * @param objectID objectID of the Synchronisable |
---|
| 204 | * @return pointer to the Synchronisable with the objectID |
---|
| 205 | */ |
---|
| 206 | Synchronisable* Synchronisable::getSynchronisable(unsigned int objectID){ |
---|
| 207 | orxonox::ObjectList<Synchronisable>::iterator it; |
---|
| 208 | for(it = orxonox::ObjectList<Synchronisable>::begin(); it; ++it){ |
---|
| 209 | if( it->getObjectID()==objectID ) |
---|
| 210 | return *it; |
---|
| 211 | } |
---|
| 212 | return NULL; |
---|
[1505] | 213 | |
---|
[1907] | 214 | // std::map<unsigned int, Synchronisable *>::iterator i = objectMap_.find(objectID); |
---|
| 215 | // if(i==objectMap_.end()) |
---|
| 216 | // return NULL; |
---|
| 217 | // assert(i->second->objectID==objectID); |
---|
| 218 | // return (*i).second; |
---|
| 219 | } |
---|
| 220 | |
---|
[1940] | 221 | |
---|
[1505] | 222 | /** |
---|
| 223 | * This function is used to register a variable to be synchronized |
---|
| 224 | * also counts the total datasize needed to save the variables |
---|
| 225 | * @param var pointer to the variable |
---|
| 226 | * @param size size of the datatype the variable consists of |
---|
[1907] | 227 | * @param t the type of the variable (network::DATA or network::STRING |
---|
| 228 | * @param mode same as in getData |
---|
| 229 | * @param cb callback object that should get called, if the value of the variable changes |
---|
[1505] | 230 | */ |
---|
[1534] | 231 | void Synchronisable::registerVar(void *var, int size, variableType t, int mode, NetworkCallbackBase *cb){ |
---|
[2011] | 232 | assert( mode==direction::toclient || mode==direction::toserver || mode==direction::serverMaster || mode==direction::clientMaster); |
---|
[1505] | 233 | // create temporary synch.Var struct |
---|
| 234 | synchronisableVariable *temp = new synchronisableVariable; |
---|
| 235 | temp->size = size; |
---|
| 236 | temp->var = var; |
---|
[1639] | 237 | temp->mode = mode; |
---|
[1505] | 238 | temp->type = t; |
---|
[1534] | 239 | temp->callback = cb; |
---|
[2011] | 240 | if( ( mode & direction::bidirectional ) ) |
---|
| 241 | { |
---|
| 242 | temp->varBuffer = new uint8_t[size]; |
---|
| 243 | memcpy(temp->varBuffer, temp->var, size); //now fill the buffer for the first time |
---|
| 244 | temp->varReference = 0; |
---|
| 245 | } |
---|
[1639] | 246 | COUT(5) << "Syncronisable::registering var with size: " << temp->size << " and type: " << temp->type << std::endl; |
---|
[1505] | 247 | //std::cout << "push temp to syncList (at the bottom) " << datasize << std::endl; |
---|
| 248 | COUT(5) << "Syncronisable::objectID: " << objectID << " this: " << this << " name: " << this->getIdentifier()->getName() << " networkID: " << this->getIdentifier()->getNetworkID() << std::endl; |
---|
| 249 | syncList->push_back(temp); |
---|
[1907] | 250 | #ifndef NDEBUG |
---|
| 251 | std::list<synchronisableVariable *>::iterator it = syncList->begin(); |
---|
| 252 | while(it!=syncList->end()){ |
---|
| 253 | assert(*it!=var); |
---|
| 254 | it++; |
---|
| 255 | } |
---|
| 256 | #endif |
---|
[1505] | 257 | } |
---|
[1856] | 258 | |
---|
[1735] | 259 | /** |
---|
[1907] | 260 | * This function takes all SynchronisableVariables out of the Synchronisable and saves them together with the size, objectID and classID to the given memory |
---|
[1735] | 261 | * takes a pointer to already allocated memory (must have at least getSize bytes length) |
---|
[1751] | 262 | * structure of the bitstream: |
---|
[1907] | 263 | * |totalsize,objectID,classID,var1,var2,string1_length,string1,var3,...| |
---|
| 264 | * length of varx: size saved int syncvarlist |
---|
| 265 | * @param mem pointer to allocated memory with enough size |
---|
| 266 | * @param id gamestateid of the gamestate to be saved (important for priorities) |
---|
| 267 | * @param mode defines the direction in which the data will be send/received |
---|
| 268 | * 0x1: server->client |
---|
| 269 | * 0x2: client->server (not recommended) |
---|
| 270 | * 0x3: bidirectional |
---|
[1990] | 271 | * @return true: if !doSync or if everything was successfully saved |
---|
[1735] | 272 | */ |
---|
[1907] | 273 | bool Synchronisable::getData(uint8_t*& mem, unsigned int id, int mode){ |
---|
| 274 | //if this tick is we dont synchronise, then abort now |
---|
[1990] | 275 | if(!doSync(id)) |
---|
[1907] | 276 | return true; |
---|
[1735] | 277 | //std::cout << "inside getData" << std::endl; |
---|
| 278 | unsigned int tempsize = 0; |
---|
| 279 | if(mode==0x0) |
---|
| 280 | mode=state_; |
---|
| 281 | if(classID==0) |
---|
| 282 | COUT(3) << "classid 0 " << this->getIdentifier()->getName() << std::endl; |
---|
[1940] | 283 | |
---|
| 284 | if (this->classID == (unsigned int)-1) |
---|
| 285 | this->classID = this->getIdentifier()->getNetworkID(); |
---|
| 286 | |
---|
[1907] | 287 | assert(this->classID==this->getIdentifier()->getNetworkID()); |
---|
| 288 | // this->classID=this->getIdentifier()->getNetworkID(); // TODO: correct this |
---|
[1735] | 289 | std::list<synchronisableVariable *>::iterator i; |
---|
| 290 | unsigned int size; |
---|
[1907] | 291 | size=getSize(id, mode); |
---|
[1856] | 292 | |
---|
[1735] | 293 | // start copy header |
---|
[1907] | 294 | synchronisableHeader *header = (synchronisableHeader *)mem; |
---|
| 295 | header->size = size; |
---|
| 296 | header->objectID = this->objectID; |
---|
[2028] | 297 | header->creatorID = this->creatorID; |
---|
[1907] | 298 | header->classID = this->classID; |
---|
| 299 | header->dataAvailable = true; |
---|
| 300 | tempsize+=sizeof(synchronisableHeader); |
---|
| 301 | mem+=sizeof(synchronisableHeader); |
---|
[1735] | 302 | // end copy header |
---|
[1856] | 303 | |
---|
| 304 | |
---|
[1735] | 305 | COUT(5) << "Synchronisable getting data from objectID: " << objectID << " classID: " << classID << " length: " << size << std::endl; |
---|
| 306 | // copy to location |
---|
| 307 | for(i=syncList->begin(); i!=syncList->end(); ++i){ |
---|
| 308 | if( ((*i)->mode & mode) == 0 ){ |
---|
| 309 | COUT(5) << "not getting data: " << std::endl; |
---|
| 310 | continue; // this variable should only be received |
---|
| 311 | } |
---|
[2011] | 312 | // if the variable gets synchronised bidirectional, then add the reference to the bytestream |
---|
| 313 | if( ( (*i)->mode & direction::bidirectional ) ) |
---|
| 314 | { |
---|
| 315 | *(uint8_t*)mem = (*i)->varReference; |
---|
| 316 | mem += sizeof( (*i)->varReference ); |
---|
| 317 | } |
---|
[1735] | 318 | switch((*i)->type){ |
---|
| 319 | case DATA: |
---|
| 320 | memcpy( (void *)(mem), (void*)((*i)->var), (*i)->size); |
---|
| 321 | mem+=(*i)->size; |
---|
[2011] | 322 | tempsize+=(*i)->size + sizeof( (*i)->varReference ); |
---|
[1735] | 323 | break; |
---|
| 324 | case STRING: |
---|
[2011] | 325 | memcpy( (void *)(mem), (void *)&((*i)->size), sizeof(size_t) ); |
---|
| 326 | mem+=sizeof(size_t); |
---|
[1735] | 327 | const char *data = ( ( *(std::string *) (*i)->var).c_str()); |
---|
| 328 | memcpy( mem, (void*)data, (*i)->size); |
---|
| 329 | COUT(5) << "synchronisable: char: " << (const char *)(mem) << " data: " << data << " string: " << *(std::string *)((*i)->var) << std::endl; |
---|
| 330 | mem+=(*i)->size; |
---|
[2011] | 331 | tempsize+=(*i)->size + sizeof( (*i)->varReference ) + sizeof(size_t); |
---|
[1735] | 332 | break; |
---|
| 333 | } |
---|
| 334 | } |
---|
| 335 | assert(tempsize==size); |
---|
| 336 | return true; |
---|
| 337 | } |
---|
[1505] | 338 | |
---|
[1856] | 339 | |
---|
[1505] | 340 | /** |
---|
[1907] | 341 | * This function takes a bytestream and loads the data into the registered variables |
---|
| 342 | * @param mem pointer to the bytestream |
---|
| 343 | * @param mode same as in getData |
---|
[1735] | 344 | * @return true/false |
---|
| 345 | */ |
---|
[1945] | 346 | bool Synchronisable::updateData(uint8_t*& mem, int mode, bool forceCallback){ |
---|
[1735] | 347 | if(mode==0x0) |
---|
| 348 | mode=state_; |
---|
| 349 | std::list<synchronisableVariable *>::iterator i; |
---|
| 350 | if(syncList->empty()){ |
---|
| 351 | COUT(4) << "Synchronisable::updateData syncList is empty" << std::endl; |
---|
| 352 | return false; |
---|
| 353 | } |
---|
[1856] | 354 | |
---|
[1907] | 355 | uint8_t *data=mem; |
---|
[1735] | 356 | // start extract header |
---|
[1907] | 357 | synchronisableHeader *syncHeader = (synchronisableHeader *)mem; |
---|
| 358 | assert(syncHeader->objectID==this->objectID); |
---|
[2032] | 359 | // assert(syncHeader->creatorID==this->creatorID); |
---|
[1907] | 360 | if(syncHeader->dataAvailable==false){ |
---|
| 361 | mem+=syncHeader->size; |
---|
[1751] | 362 | return true; |
---|
[1907] | 363 | } |
---|
[1856] | 364 | |
---|
[1907] | 365 | mem+=sizeof(synchronisableHeader); |
---|
| 366 | // stop extract header |
---|
| 367 | assert(this->objectID==syncHeader->objectID); |
---|
| 368 | // assert(this->classID==syncHeader->classID); //TODO: fix this!!! maybe a problem with the identifier ? |
---|
[1940] | 369 | |
---|
[1907] | 370 | COUT(5) << "Synchronisable: objectID " << syncHeader->objectID << ", classID " << syncHeader->classID << " size: " << syncHeader->size << " synchronising data" << std::endl; |
---|
| 371 | for(i=syncList->begin(); i!=syncList->end() && mem <= data+syncHeader->size; i++){ |
---|
[1735] | 372 | if( ((*i)->mode ^ mode) == 0 ){ |
---|
| 373 | COUT(5) << "synchronisable: not updating variable " << std::endl; |
---|
| 374 | continue; // this variable should only be set |
---|
| 375 | } |
---|
| 376 | COUT(5) << "Synchronisable: element size: " << (*i)->size << " type: " << (*i)->type << std::endl; |
---|
| 377 | bool callback=false; |
---|
| 378 | switch((*i)->type){ |
---|
| 379 | case DATA: |
---|
[2011] | 380 | if( ( (*i)->mode & direction::bidirectional ) ) |
---|
| 381 | { |
---|
| 382 | if( ( mode == 0x1 && (*i)->mode == direction::serverMaster ) || \ |
---|
| 383 | ( mode == 0x2 && (*i)->mode == direction::clientMaster ) ) // if true we are master on this variable |
---|
| 384 | { |
---|
| 385 | uint8_t refNr = *(uint8_t *)mem; |
---|
| 386 | if( refNr != (*i)->varReference ) |
---|
| 387 | { |
---|
| 388 | mem += sizeof((*i)->varReference) + (*i)->size; // the reference for this variable is not recent, discard data |
---|
| 389 | break; |
---|
| 390 | } |
---|
| 391 | } |
---|
| 392 | else //we are slave for this variable |
---|
| 393 | { |
---|
| 394 | (*i)->varReference = *(uint8_t *)mem; //copy the reference value for this variable |
---|
| 395 | } |
---|
| 396 | mem += sizeof((*i)->varReference); |
---|
| 397 | } |
---|
[1735] | 398 | if((*i)->callback) // check whether this variable changed (but only if callback was set) |
---|
| 399 | if(strncmp((char *)(*i)->var, (char *)mem, (*i)->size)!=0) |
---|
| 400 | callback=true; |
---|
| 401 | memcpy((void*)(*i)->var, mem, (*i)->size); |
---|
| 402 | mem+=(*i)->size; |
---|
| 403 | break; |
---|
| 404 | case STRING: |
---|
[2011] | 405 | if( ( (*i)->mode & direction::bidirectional ) ) |
---|
| 406 | { |
---|
| 407 | if( ( mode == 0x1 && (*i)->mode == direction::serverMaster ) || \ |
---|
| 408 | ( mode == 0x2 && (*i)->mode == direction::clientMaster ) ) // if true we are master for this variable |
---|
| 409 | { |
---|
| 410 | uint8_t refNr = *(uint8_t *)mem; |
---|
| 411 | mem += sizeof( (*i)->varReference ); |
---|
| 412 | if( refNr != (*i)->varReference ){ |
---|
| 413 | mem += sizeof(size_t) + *(size_t *)mem; // the reference for this variable is not recent, discard data |
---|
| 414 | break; |
---|
| 415 | } |
---|
| 416 | } |
---|
| 417 | else //we are slave for this variable |
---|
| 418 | { |
---|
| 419 | (*i)->varReference = *(uint8_t *)mem; //copy the reference value for this variable |
---|
| 420 | } |
---|
| 421 | mem += sizeof( (*i)->varReference ); |
---|
| 422 | } |
---|
| 423 | (*i)->size = *(size_t *)mem; |
---|
[1735] | 424 | COUT(5) << "string size: " << (*i)->size << std::endl; |
---|
[2011] | 425 | mem += sizeof(size_t); |
---|
[1735] | 426 | if((*i)->callback) // check whether this string changed |
---|
| 427 | if( *(std::string *)((*i)->var) != std::string((char *)mem) ) |
---|
| 428 | callback=true; |
---|
| 429 | *((std::string *)((*i)->var)) = std::string((const char*)mem); |
---|
| 430 | COUT(5) << "synchronisable: char: " << (const char*)mem << " string: " << std::string((const char*)mem) << std::endl; |
---|
| 431 | mem += (*i)->size; |
---|
| 432 | break; |
---|
| 433 | } |
---|
| 434 | // call the callback function, if defined |
---|
[1945] | 435 | if((callback || forceCallback) && (*i)->callback) |
---|
[1735] | 436 | (*i)->callback->call(); |
---|
| 437 | } |
---|
| 438 | return true; |
---|
| 439 | } |
---|
[1505] | 440 | |
---|
| 441 | /** |
---|
| 442 | * This function returns the total amount of bytes needed by getData to save the whole content of the variables |
---|
[1907] | 443 | * @param id id of the gamestate |
---|
| 444 | * @param mode same as getData |
---|
[1505] | 445 | * @return amount of bytes |
---|
| 446 | */ |
---|
[1907] | 447 | uint32_t Synchronisable::getSize(unsigned int id, int mode){ |
---|
[1990] | 448 | if(!doSync(id)) |
---|
[1751] | 449 | return 0; |
---|
[1907] | 450 | int tsize=sizeof(synchronisableHeader); |
---|
[1505] | 451 | if(mode==0x0) |
---|
| 452 | mode=state_; |
---|
| 453 | std::list<synchronisableVariable *>::iterator i; |
---|
| 454 | for(i=syncList->begin(); i!=syncList->end(); i++){ |
---|
| 455 | if( ((*i)->mode & mode) == 0 ) |
---|
| 456 | continue; // this variable should only be received, so dont add its size to the send-size |
---|
| 457 | switch((*i)->type){ |
---|
| 458 | case DATA: |
---|
| 459 | tsize+=(*i)->size; |
---|
| 460 | break; |
---|
| 461 | case STRING: |
---|
| 462 | tsize+=sizeof(int); |
---|
| 463 | (*i)->size=((std::string *)(*i)->var)->length()+1; |
---|
| 464 | COUT(5) << "String size: " << (*i)->size << std::endl; |
---|
| 465 | tsize+=(*i)->size; |
---|
| 466 | break; |
---|
| 467 | } |
---|
[2011] | 468 | if( ( (*i)->mode & direction::bidirectional ) != 0) |
---|
| 469 | { |
---|
| 470 | tsize+=sizeof( (*i)->varReference ); |
---|
| 471 | } |
---|
[1505] | 472 | } |
---|
| 473 | return tsize; |
---|
| 474 | } |
---|
[1639] | 475 | |
---|
[1735] | 476 | /** |
---|
[1907] | 477 | * This function determines, wheter the object should be saved to the bytestream (according to its syncmode/direction) |
---|
| 478 | * @param id gamestate id |
---|
| 479 | * @return true/false |
---|
[1735] | 480 | */ |
---|
[1990] | 481 | bool Synchronisable::doSync(unsigned int id){ |
---|
[2033] | 482 | return ( (objectMode_&state_)!=0 && (!syncList->empty() ) ); |
---|
[1735] | 483 | } |
---|
[1856] | 484 | |
---|
[1907] | 485 | bool Synchronisable::doSelection(unsigned int id){ |
---|
[1751] | 486 | return ( id==0 || id%objectFrequency_==objectID%objectFrequency_ ) && ((objectMode_&state_)!=0); |
---|
| 487 | } |
---|
[1856] | 488 | |
---|
[1907] | 489 | /** |
---|
| 490 | * This function looks at the header located in the bytestream and checks wheter objectID and classID match with the Synchronisables ones |
---|
| 491 | * @param mem pointer to the bytestream |
---|
| 492 | */ |
---|
| 493 | bool Synchronisable::isMyData(uint8_t* mem) |
---|
[1735] | 494 | { |
---|
[1907] | 495 | synchronisableHeader *header = (synchronisableHeader *)mem; |
---|
| 496 | assert(header->objectID==this->objectID); |
---|
| 497 | return header->dataAvailable; |
---|
[1735] | 498 | } |
---|
[1856] | 499 | |
---|
[1907] | 500 | /** |
---|
| 501 | * This function sets the synchronisation mode of the object |
---|
| 502 | * If set to 0x1 variables will only be synchronised to the client |
---|
| 503 | * If set to 0x2 variables will only be synchronised to the server |
---|
| 504 | * If set to 0x3 variables will be synchronised bidirectionally (only if set so in registerVar) |
---|
| 505 | * @param mode same as in registerVar |
---|
| 506 | */ |
---|
[1751] | 507 | void Synchronisable::setObjectMode(int mode){ |
---|
[1989] | 508 | assert(mode==0x0 || mode==0x1 || mode==0x2 || mode==0x3); |
---|
[1751] | 509 | objectMode_=mode; |
---|
[1505] | 510 | } |
---|
| 511 | |
---|
[1639] | 512 | |
---|
[1505] | 513 | } |
---|