Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 1740 was 1735, checked in by scheusso, 16 years ago

network branch merged into trunk

  • Property svn:eol-style set to native
File size: 3.2 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 "core/OrxonoxClass.h"
36#include "NetworkCallback.h"
37
38namespace network
39{
40  enum variableType{
41    DATA,
42    STRING,
43  };
44
45  struct syncData{
46    unsigned int length;
47    unsigned int objectID;
48    unsigned int classID;
49    unsigned char *data;
50  };
51
52  typedef struct synchronisableVariable{
53    unsigned int size;
54    int mode; // this determines in which direction the variable gets synchronised
55    void *var;
56    variableType type;
57    NetworkCallbackBase *callback;
58  }SYNCVAR;
59
60
61  /**
62  * This class is the base class of all the Objects in the universe that need to be synchronised over the network
63   * Every class, t
64  int mode;hat inherits from this class has to link the DATA THAT NEEDS TO BE SYNCHRONISED into the linked list. Additionally it also has to provide a Constructor, that takes exactly the variables in this linked list.
65  * @author Oliver Scheuss
66  */
67  class _NetworkExport Synchronisable : virtual public orxonox::OrxonoxClass{
68  public:
69
70    virtual ~Synchronisable();
71    unsigned int objectID;
72    unsigned int classID;
73
74    void registerVar(void *var, int size, variableType t, int mode=1, NetworkCallbackBase *cb=0);
75    //  syncData getData();
76    syncData getData(unsigned char *mem, int mode=0x0);
77    bool getData2(unsigned char*& men, int mode=0x0);
78    //bool getData(Bytestream& bs, int mode=0x0);
79    int getSize(int mode=0x0);
80    int getSize2(int mode=0x0);
81    bool updateData(syncData vars, int mode=0x0);
82    bool updateData(unsigned char*& mem, int mode=0x0);
83    bool isMyData(unsigned char* mem);
84    void setBacksync(bool sync);
85    bool getBacksync();
86    virtual void registerAllVariables()=0;
87    virtual bool create();
88    static void setClient(bool b);
89   
90    static bool fabricate(unsigned char*& mem, int mode=0x0);
91  protected:
92    Synchronisable();
93  private:
94    /*  bool removeObject(Iterator<Synchronisable> it);*/
95
96    std::list<synchronisableVariable *> *syncList;
97    int datasize;
98    static int state_; // detemines wheter we are server (default) or client
99    bool backsync_; // if true the variables with mode > 1 will be synchronised to server (client -> server)
100  };
101}
102
103#endif /* _Synchronisable_H__ */
Note: See TracBrowser for help on using the repository browser.