Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/branches/water/src/lib/network/synchronizeable.h @ 8625

Last change on this file since 8625 was 8068, checked in by patrick, 18 years ago

trunk: merged the network branche back to trunk

File size: 3.5 KB
Line 
1/*!
2 * @file synchronizeable.h
3    \brief interface for all classes that have to be synchronized
4 */
5
6#ifndef _SYNCHRONIZEABLE_H
7#define _SYNCHRONIZEABLE_H
8
9#include "base_object.h"
10#include "netdefs.h"
11#include "converter.h"
12#include "vector.h"
13#include "quaternion.h"
14#include "synchronizeable_var/synchronizeable_var.h"
15#include "synchronizeable_var/synchronizeable_vector.h"
16#include "synchronizeable_var/synchronizeable_quaternion.h"
17#include "synchronizeable_var/synchronizeable_string.h"
18#include "synchronizeable_var/synchronizeable_int.h"
19#include "synchronizeable_var/synchronizeable_float.h"
20#include "synchronizeable_var/synchronizeable_bool.h"
21#include "synchronizeable_var/synchronizeable_uint.h"
22
23
24#include <vector>
25#include <list>
26
27//State constants: They have to be of the form 2^n
28#define STATE_SERVER 1
29
30struct StateHistoryEntry
31{
32  int             stateId;
33  byte *          data;
34  int             dataLength;
35  std::list<int>  sizeList;
36};
37
38typedef std::list<StateHistoryEntry*> StateHistory;
39
40typedef std::vector<StateHistory> UserStateHistory;
41
42typedef std::vector<SynchronizeableVar*> SyncVarList;
43
44class NetworkStream;
45
46class Synchronizeable : virtual public BaseObject
47{
48
49  public:
50    Synchronizeable();
51    virtual ~Synchronizeable();
52
53    void setIsServer( bool isServer );
54    bool isServer();
55
56    virtual void varChangeHandler( std::list<int> & id );
57
58    virtual int getStateDiff( int userId, byte* data, int maxLength, int stateId, int fromStateId, int priorityTH );
59    virtual int setStateDiff( int userId, byte* data, int length, int stateId, int fromStateId );
60    virtual void cleanUpUser( int userId );
61    virtual void handleSentState( int userId, int stateId, int fromStateId );
62    virtual void handleRecvState( int userId, int stateId, int fromStateId );
63   
64    void registerVar( SynchronizeableVar * var );
65    int registerVarId( SynchronizeableVar * var );
66
67    inline void setUniqueID( int id ){ uniqueID = id; }
68    inline int  getUniqueID() const { return uniqueID; }
69    inline int getHostID() { return this->hostID; }
70
71    inline int getOwner(){ return owner; }
72    inline void setOwner(int owner){ this->owner = owner; }
73
74    /** @returns true if this Synchronizeable wants to be synchronized over network */
75    inline bool beSynchronized() { return this->bSynchronize; }
76    /** @param bSynchronize sets the Synchronizeable to be sunchronized or not */
77    inline void setSynchronized(bool bSynchronize) { this->bSynchronize = bSynchronize; }
78
79    inline void setNetworkStream(NetworkStream* stream) { this->networkStream = stream; }
80    inline NetworkStream* getNetworkStream() { return this->networkStream; }
81
82
83  protected:
84    NetworkStream*    networkStream;  //!< reference network stream we are connected to
85    int               state;
86
87  private:
88    int               uniqueID;       //!< unique id assigned to synchronizeable
89    int               mLeafClassId;   //!< store leafClassId to send via states
90    int               owner;          //!< hostId of owner ( 0 if none / server )
91    int               hostID;         //!< my own host id
92    bool              bSynchronize;   //!< do we need beeing synchronized?
93
94    SyncVarList       syncVarList;    //!< list containing variables to synchronize
95
96    UserStateHistory  sentStates;     //!< store already sent states to create diffs from, offset corresponds to the user id
97    UserStateHistory  recvStates;     //!< store recieved states to apply diffs, offset corresponds to the user id
98
99};
100#endif /* _SYNCHRONIZEABLE_H */
Note: See TracBrowser for help on using the repository browser.