Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/SuperOrxoBros_HS18/src/libraries/network/synchronisable/Synchronisable.cc @ 12177

Last change on this file since 12177 was 12177, checked in by siramesh, 5 years ago

Super Orxo Bros Final (Sidharth Ramesh, Nisa Balta, Jeff Ren)

File size: 15.6 KB
Line 
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#include "Synchronisable.h"
32
33#include <cstdlib>
34#include "core/CoreIncludes.h"
35#include "core/GameMode.h"
36#include "core/BaseObject.h"
37#include "network/Host.h"
38
39namespace orxonox
40{
41
42  std::map<uint32_t, Synchronisable *> Synchronisable::objectMap_;
43  std::queue<uint32_t> Synchronisable::deletedObjects_;
44
45  uint8_t Synchronisable::state_=0x1; // determines wheter we are server (default) or client
46
47  RegisterAbstractClass(Synchronisable).inheritsFrom<OrxonoxInterface>();
48
49  /**
50  * Constructor:
51  * Initializes all Variables and sets the right objectID_
52  */
53  Synchronisable::Synchronisable(Context* context)
54  {
55    RegisterObject(Synchronisable);
56    static uint32_t idCounter=0;
57    objectMode_=0x1; // by default do not send data to server
58    if ( GameMode::isMaster()/* || ( Host::running() && Host::isServer() )*/ )
59    {
60      this->setObjectID( idCounter++ );
61    }
62    else
63    {
64      objectID_=OBJECTID_UNKNOWN;
65    }
66    classID_ = static_cast<uint32_t>(-1);
67
68    // set dataSize to 0
69    this->dataSize_ = 0;
70    // set standard priority
71    this->setPriority( Priority::Normal );
72
73    // get context id
74    this->contextID_ = this->findContextID(context);
75  }
76
77  /**
78   * Destructor:
79   * Delete all callback objects and remove objectID_ from the objectMap_
80   */
81  Synchronisable::~Synchronisable()
82  {
83    // delete callback function objects
84    if(!IdentifierManager::getInstance().isCreatingHierarchy()){
85      // remove object from the static objectMap
86      if (this->objectMode_ != 0x0 && (Host::running() && Host::isServer()))
87        deletedObjects_.push(objectID_);
88    }
89    // delete all Synchronisable Variables from syncList_ ( which are also in stringList_ )
90    for(SynchronisableVariableBase* variable : syncList_)
91      delete variable;
92    syncList_.clear();
93    stringList_.clear();
94    std::map<uint32_t, Synchronisable*>::iterator it2;
95    it2 = objectMap_.find(objectID_);
96    if (it2 != objectMap_.end())
97      objectMap_.erase(it2);
98
99  }
100
101  /**
102   * @brief Returns the id of the context.
103   * If the context is not Synchronisable, it moves on to its parent, recursively.
104   */
105  uint32_t Synchronisable::findContextID(Context* context)
106  {
107      if (context == nullptr)
108          return OBJECTID_UNKNOWN;
109
110      Synchronisable* synchronisableContext = orxonox_cast<Synchronisable*>(context);
111      if (synchronisableContext != nullptr)
112          return synchronisableContext->getObjectID();
113      else
114          return this->findContextID(context->getParentContext());
115  }
116
117  /**
118   * This function sets the internal mode for synchronisation
119   * @param b true if this object is located on a client or on a server
120   */
121  void Synchronisable::setClient(bool b)
122  {
123    if(b) // client
124      state_=0x2;
125    else  // server
126      state_=0x1;
127  }
128
129  /**
130   * This function fabricated a new synchrnisable (and children of it), sets calls updateData and create
131   * After calling this function the mem pointer will be increased by the size of the needed data
132   * @param mem pointer to where the appropriate data is located
133   * @param mode defines the mode, how the data should be loaded
134   * @return pointer to the newly created synchronisable
135   */
136  Synchronisable *Synchronisable::fabricate(uint8_t*& mem, uint8_t mode)
137  {
138    SynchronisableHeader header(mem);
139    if( header.isDiffed() )
140    {
141      mem += header.getDataSize() + header.getSize();
142      return nullptr;
143    }
144//     assert( !header.isDiffed() );
145
146    orxout(verbose, context::network) << "fabricating object with id: " << header.getObjectID() << endl;
147
148    Identifier* id = ClassByID(header.getClassID());
149    if (!id)
150    {
151        for(int i = 0; i<160; i++)
152            orxout(user_error, context::network) << "classid: " << i << " identifier: " << ClassByID(i) << endl;
153        orxout(user_error, context::network) << "Assertion failed: Could not find Identifier for ClassID " << header.getClassID() << endl;
154        orxout(user_error, context::network) << "Possible reason for this error: Client received a synchronizable object whose class has no factory." << endl;
155        abort();
156    }
157    assert(id);
158    Context* context = nullptr;
159    if (header.getContextID() != OBJECTID_UNKNOWN)
160    {
161      Synchronisable* synchronisable_context = Synchronisable::getSynchronisable(header.getContextID());
162      if (!synchronisable_context)
163      {
164        mem += header.getDataSize()+SynchronisableHeader::getSize(); //.TODO: this suckz.... remove size from header
165        assert(0); // TODO: uncomment this if we have a clean objecthierarchy (with destruction of children of objects) ^^
166        return nullptr;
167      }
168      else
169        context = orxonox_cast<Context*>(synchronisable_context);
170    }
171    else
172      context = Context::getRootContext();
173
174    assert(getSynchronisable(header.getObjectID())==nullptr);   //make sure no object with this id exists
175    BaseObject *bo = orxonox_cast<BaseObject*>(id->fabricate(context));
176    assert(bo);
177    Synchronisable *no = orxonox_cast<Synchronisable*>(bo);
178    assert(no);
179    assert( Synchronisable::objectMap_.find(header.getObjectID()) == Synchronisable::objectMap_.end() );
180    no->setObjectID(header.getObjectID());
181    no->setClassID(header.getClassID());
182    assert(no->contextID_ == header.getContextID());
183    orxout(verbose, context::network) << "fabricate objectID_: " << no->objectID_ << " classID_: " << no->classID_ << endl;
184          // update data and create object/entity...
185    bool b = no->updateData(mem, mode, true);
186    assert(b);
187    if (b)
188    {
189        assert(b);
190    }
191    return no;
192  }
193
194
195  /**
196   * Finds and deletes the Synchronisable with the appropriate objectID_
197   * @param objectID_ objectID_ of the Synchronisable
198   * @return true/false
199   */
200  bool Synchronisable::deleteObject(uint32_t objectID_)
201  {
202    if(!getSynchronisable(objectID_))
203      return false;
204    assert(getSynchronisable(objectID_)->objectID_==objectID_);
205    Synchronisable *s = getSynchronisable(objectID_);
206    if(s)
207      s->destroy(); // or delete?
208    else
209      return false;
210    return true;
211  }
212
213  /**
214   * This function looks up the objectID_ in the objectMap_ and returns a pointer to the right Synchronisable
215   * @param objectID_ objectID_ of the Synchronisable
216   * @return pointer to the Synchronisable with the objectID_
217   */
218  Synchronisable* Synchronisable::getSynchronisable(uint32_t objectID_)
219  {
220    std::map<uint32_t, Synchronisable*>::iterator it1;
221    it1 = objectMap_.find(objectID_);
222    if (it1 != objectMap_.end())
223      return it1->second;
224    // if the objects not in the map it should'nt exist at all anymore
225    return nullptr;
226  }
227
228
229  /**
230   * This function takes all SynchronisableVariables out of the Synchronisable and saves them together with the size, objectID_ and classID_ to the given memory
231   * takes a pointer to already allocated memory (must have at least getSize bytes length)
232   * structure of the bitstream:
233   * |totalsize,objectID_,classID_,var1,var2,string1_length,string1,var3,...|
234   * length of varx: size saved int syncvarlist
235   * @param mem pointer to allocated memory with enough size
236   * @param sizes vector containing sizes of all objects in gamestate (to be appended)
237   * @param id gamestateid of the gamestate to be saved (important for priorities)
238   * @param mode defines the direction in which the data will be send/received
239   *             0x1: server->client
240   *             0x2: client->server
241   *             0x3: bidirectional
242   * @return true: if !doSync or if everything was successfully saved
243   */
244  uint32_t Synchronisable::getData(uint8_t*& mem, std::vector<uint32_t>& sizes, int32_t id, uint8_t mode)
245  {
246    unsigned int test = 0;
247    if(mode==0x0)
248      mode=state_;
249    //if this tick is we dont synchronise, then abort now
250    if(!doSync(/*id,*/ mode))
251      return 0;
252    uint32_t tempsize = 0;
253#ifndef NDEBUG
254    uint8_t* oldmem = mem;
255    if (this->classID_==0)
256      orxout(internal_info, context::network) << "classid 0 " << this->getIdentifier()->getName() << endl;
257#endif
258
259    if (this->classID_ == static_cast<uint32_t>(-1))
260        this->classID_ = this->getIdentifier()->getNetworkID();
261
262    assert(ClassByID(this->classID_));
263    assert(this->classID_==this->getIdentifier()->getNetworkID());
264    assert(this->objectID_!=OBJECTID_UNKNOWN);
265
266    // start copy header
267    SynchronisableHeader header(mem);
268    mem += SynchronisableHeader::getSize();
269    // end copy header
270
271    orxout(verbose_more, context::network) << "getting data from objectID_: " << objectID_ << ", classID_: " << classID_ << endl;
272    // copy to location
273    for(SynchronisableVariableBase* variable : syncList_)
274    {
275      uint32_t varsize = variable->getData( mem, mode );
276      tempsize += varsize;
277      sizes.push_back(varsize);
278      ++test;
279    }
280    assert(tempsize!=0);  // if this happens an empty object (with no variables) would be transmitted
281
282    header.setObjectID( this->objectID_ );
283    header.setContextID( this->contextID_ );
284    header.setClassID( this->classID_ );
285    header.setDataSize( tempsize );
286    assert( tempsize == mem-oldmem-SynchronisableHeader::getSize() );
287    assert( test == this->getNrOfVariables() );
288    header.setDiffed(false);
289    tempsize += SynchronisableHeader::getSize();
290
291#ifndef NDEBUG
292    uint32_t size;
293    size=getSize(id, mode);
294    assert(tempsize==size);
295#endif
296    return tempsize;
297  }
298
299
300  /**
301   * This function takes a bytestream and loads the data into the registered variables
302   * @param mem pointer to the bytestream
303   * @param mode same as in getData
304   * @param forceCallback this makes updateData call each callback
305   * @return true/false
306   */
307  bool Synchronisable::updateData(uint8_t*& mem, uint8_t mode, bool forceCallback)
308  {
309    if(mode==0x0)
310      mode=state_;
311   
312    if(syncList_.empty())
313    {
314      orxout(internal_warning, context::network) << "Synchronisable::updateData syncList_ is empty" << endl;
315      assert(0);
316      return false;
317    }
318
319    uint8_t* data=mem;
320    // start extract header
321    SynchronisableHeaderLight syncHeaderLight(mem);
322    assert(syncHeaderLight.getObjectID()==this->getObjectID());
323   
324    if( !this->doReceive(mode) )
325    {
326      uint32_t headerSize;
327      if( syncHeaderLight.isDiffed() )
328        headerSize = SynchronisableHeaderLight::getSize();
329      else
330        headerSize = SynchronisableHeader::getSize();
331      mem += syncHeaderLight.getDataSize() + headerSize;
332      return true;
333    }
334
335    if( !syncHeaderLight.isDiffed() )
336    {
337      SynchronisableHeader syncHeader2(mem);
338      assert( this->getClassID() == syncHeader2.getClassID() );
339      assert( this->getContextID() == syncHeader2.getContextID() );
340      mem += SynchronisableHeader::getSize();
341      for(SynchronisableVariableBase* variable : syncList_)
342      {
343        assert( mem <= data+syncHeader2.getDataSize()+SynchronisableHeader::getSize() ); // always make sure we don't exceed the datasize in our stream
344        variable->putData( mem, mode, forceCallback );
345      }
346      assert(mem == data+syncHeaderLight.getDataSize()+SynchronisableHeader::getSize() );
347    }
348    else
349    {
350      mem += SynchronisableHeaderLight::getSize();
351      while( mem < data+syncHeaderLight.getDataSize()+SynchronisableHeaderLight::getSize() )
352      {
353        VariableID varID = *(VariableID*)mem;
354        assert( varID < syncList_.size() );
355        mem += sizeof(VariableID);
356        syncList_[varID]->putData( mem, mode, forceCallback );
357      }
358      assert(mem == data+syncHeaderLight.getDataSize()+SynchronisableHeaderLight::getSize() );
359    }
360    return true;
361  }
362
363  /**
364  * This function returns the total amount of bytes needed by getData to save the whole content of the variables
365  * @param id id of the gamestate
366  * @param mode same as getData
367  * @return amount of bytes
368  */
369  uint32_t Synchronisable::getSize(int32_t id, uint8_t mode)
370  {
371    uint32_t tsize=SynchronisableHeader::getSize();
372    if (mode==0x0)
373      mode=state_;
374    if (!doSync(/*id, */mode))
375      return 0;
376    assert( mode==state_ );
377    tsize += this->dataSize_;
378    for(SynchronisableVariableBase* variable : stringList_)
379    {
380      tsize += variable->getSize( mode );
381    }
382    return tsize;
383  }
384
385  /**
386   * This function determines, wheter the object should be saved to the bytestream (according to its syncmode/direction)
387   * @param mode Synchronisation mode (toclient, toserver or bidirectional)
388   * @return true/false
389   */
390  bool Synchronisable::doSync(/*int32_t id,*/ uint8_t mode)
391  {
392    assert(mode!=0x0);
393    return ( (this->objectMode_ & mode)!=0 && (!syncList_.empty() ) );
394  }
395 
396  /**
397   * This function determines, wheter the object should accept data from the bytestream (according to its syncmode/direction)
398   * @param mode Synchronisation mode (toclient, toserver or bidirectional)
399   * @return true/false
400   */
401  bool Synchronisable::doReceive( uint8_t mode)
402  {
403    //return mode != this->objectMode_ || this->objectMode_ == ObjectDirection::Bidirectional;
404    return true;
405  }
406
407  /**
408   * This function sets the synchronisation mode of the object
409   * If set to 0x0 variables will not be synchronised at all
410   * If set to 0x1 variables will only be synchronised to the client
411   * If set to 0x2 variables will only be synchronised to the server
412   * If set to 0x3 variables will be synchronised bidirectionally (only if set so in registerVar)
413   * @param mode same as in registerVar
414   */
415  void Synchronisable::setSyncMode(uint8_t mode)
416  {
417    assert(mode==0x0 || mode==0x1 || mode==0x2 || mode==0x3);
418    this->objectMode_=mode;
419  }
420
421  template <> void Synchronisable::registerVariable( std::string& variable, uint8_t mode, NetworkCallbackBase *cb, bool bidirectional)
422  {
423    SynchronisableVariableBase* sv;
424    if (bidirectional)
425      sv = new SynchronisableVariableBidirectional<std::string>(variable, mode, cb);
426    else
427      sv = new SynchronisableVariable<std::string>(variable, mode, cb);
428    syncList_.push_back(sv);
429    stringList_.push_back(sv);
430  }
431
432template <> void Synchronisable::unregisterVariable( std::string& variable )
433  {
434    bool unregistered_nonexistent_variable = true;
435    std::vector<SynchronisableVariableBase*>::iterator it = syncList_.begin();
436    while(it!=syncList_.end())
437    {
438      if( ((*it)->getReference()) == &variable )
439      {
440        delete (*it);
441        syncList_.erase(it);
442        unregistered_nonexistent_variable = false;
443        break;
444      }
445      else
446        ++it;
447    }
448    assert(unregistered_nonexistent_variable == false);
449    (void)unregistered_nonexistent_variable; // avoid compiler warning
450   
451    it = stringList_.begin();
452    while(it!=stringList_.end())
453    {
454      if( ((*it)->getReference()) == &variable )
455      {
456        delete (*it);
457        stringList_.erase(it);
458        return;
459      }
460      else
461        ++it;
462    }
463    assert(false); //if we reach this point something went wrong:
464    // the variable has not been registered before
465  }
466
467
468}
Note: See TracBrowser for help on using the repository browser.