Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/network/Synchronisable.h @ 1909

Last change on this file since 1909 was 1909, checked in by rgrieder, 15 years ago

merge adjustments for msvc

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