Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/objecthierarchy/src/network/Synchronisable.h @ 2034

Last change on this file since 2034 was 2034, checked in by landauf, 16 years ago

Synchronisable translates creator ↔ creatorID

  • Property svn:eol-style set to native
File size: 4.4 KB
RevLine 
[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 *      Oliver Scheuss, (C) 2007
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#ifndef _Synchronisable_H__
30#define _Synchronisable_H__
31
32#include "NetworkPrereqs.h"
33
34#include <list>
[1907]35#include <map>
36#include <queue>
[1909]37#include "util/Integers.h"
[1505]38#include "core/OrxonoxClass.h"
[1841]39#include "core/XMLIncludes.h"
[1534]40#include "NetworkCallback.h"
[1910]41#include "util/Integers.h"
[1505]42
[1940]43#define REGISTERDATA(varname, ...) \
44    registerVar((void*)&varname, sizeof(varname), network::DATA, __VA_ARGS__)
45#define REGISTERSTRING(stringname, ...) \
46    registerVar(&stringname, stringname.length()+1, network::STRING, __VA_ARGS__)
[1907]47
[1505]48namespace network
49{
[1989]50  static const unsigned int OBJECTID_UNKNOWN = (unsigned int)-1;
51
[1907]52  namespace direction{
53    enum syncdirection{
54      toclient=0x1,
55      toserver=0x2,
[2011]56      bidirectional=0x3,
57      serverMaster=0x3,
58      clientMaster=0x7
[1907]59    };
60  }
[1916]61
[1907]62  namespace syncmode{
63    enum mode{
64      one=0,
65      always=1
66    };
67  }
[1916]68
[1505]69  enum variableType{
70    DATA,
71    STRING,
72  };
73
[1916]74  struct _NetworkExport synchronisableHeader{
[1907]75    uint32_t size:31;
76    bool dataAvailable:1;
77    uint32_t objectID;
[2028]78    uint32_t creatorID;
[1907]79    uint32_t classID;
[1505]80  };
81
[2011]82  struct _NetworkExport synchronisableVariable{
[1735]83    unsigned int size;
[1505]84    int mode; // this determines in which direction the variable gets synchronised
85    void *var;
86    variableType type;
[1534]87    NetworkCallbackBase *callback;
[2011]88    void *varBuffer;
89    uint8_t varReference;
90  };
[1505]91
92  /**
93  * This class is the base class of all the Objects in the universe that need to be synchronised over the network
[1907]94   * Every class, that inherits from this class has to link the DATA THAT NEEDS TO BE SYNCHRONISED into the linked list.
[1505]95  * @author Oliver Scheuss
96  */
97  class _NetworkExport Synchronisable : virtual public orxonox::OrxonoxClass{
98  public:
[1907]99    friend class packet::Gamestate;
100    friend class GamestateClient;
101    friend class Server;
[1505]102    virtual ~Synchronisable();
103
[1916]104
[1505]105    virtual bool create();
106    static void setClient(bool b);
[1916]107
[1907]108    static Synchronisable *fabricate(uint8_t*& mem, int mode=0x0);
109    static bool deleteObject(unsigned int objectID);
110    static Synchronisable *getSynchronisable(unsigned int objectID);
111    static unsigned int getNumberOfDeletedObject(){ return deletedObjects_.size(); }
112    static unsigned int popDeletedObject(){ unsigned int i = deletedObjects_.front(); deletedObjects_.pop(); return i; }
[1916]113
[1907]114    inline unsigned int getObjectID(){return objectID;}
115    inline unsigned int getClassID(){return classID;}
[1505]116  protected:
[2034]117    Synchronisable(orxonox::BaseObject* creator);
[1907]118    void registerVar(void *var, int size, variableType t, int mode=1, NetworkCallbackBase *cb=0);
119    void setObjectMode(int mode);
120    void setObjectFrequency(unsigned int freq){ objectFrequency_ = freq; }
[1916]121
122
[1505]123  private:
[1907]124    bool getData(uint8_t*& men, unsigned int id, int mode=0x0);
125    uint32_t getSize(unsigned int id, int mode=0x0);
[1945]126    bool updateData(uint8_t*& mem, int mode=0x0, bool forceCallback=false);
[1907]127    bool isMyData(uint8_t* mem);
128    bool doSelection(unsigned int id);
[1990]129    bool doSync(unsigned int id);
[1916]130
[1907]131    unsigned int objectID;
[2028]132    unsigned int creatorID;
[1907]133    unsigned int classID;
[1916]134
[1505]135    std::list<synchronisableVariable *> *syncList;
136    static int state_; // detemines wheter we are server (default) or client
137    bool backsync_; // if true the variables with mode > 1 will be synchronised to server (client -> server)
[1751]138    unsigned int objectFrequency_;
139    int objectMode_;
[1907]140    static std::map<unsigned int, Synchronisable *> objectMap_;
141    static std::queue<unsigned int> deletedObjects_;
[1505]142  };
143}
144
145#endif /* _Synchronisable_H__ */
Note: See TracBrowser for help on using the repository browser.