Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/network/packet/Packet.h @ 7490

Last change on this file since 7490 was 7490, checked in by scheusso, 14 years ago

cleaning up function calls a bit in order to buffer calls for not (yet) existing objects

  • Property svn:eol-style set to native
File size: 2.7 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 <scheusso [at] ee.ethz.ch>, (C) 2008
24 *   Co-authors:
25 *      ...
26 *
27 */
28#ifndef _NETWORK_Packet_H__
29#define _NETWORK_Packet_H__
30
31#include "network/NetworkPrereqs.h"
32#include <map>
33
34namespace orxonox {
35
36namespace packet{
37
38namespace Direction{
39  enum Value{
40    Incoming,
41    Outgoing,
42    Bidirectional
43  };
44}
45namespace Type{
46  enum Value{
47    Acknowledgement,
48    Chat,
49    ClassID,
50    DeleteObjects,
51    FunctionIDs,
52    FunctionCalls,
53    Gamestate,
54    Welcome
55  };
56}
57
58/**
59    @author Oliver Scheuss <scheusso [at] ee.ethz.ch>
60*/
61class _NetworkExport Packet{
62  public:
63    Packet(const Packet &p);
64    virtual ~Packet();
65    static Packet *createPacket(ENetPacket *packet, ENetPeer *peer);
66    static void deletePacket(ENetPacket *packet);
67
68    virtual unsigned char *getData(){ return data_; };
69    virtual unsigned int getSize() const =0;
70    virtual bool process()=0;
71    inline uint32_t getFlags()
72      { return flags_; }
73    inline int getClientID()
74      { return clientID_; }
75    inline void setClientID( int id )
76      { clientID_ = id; }
77
78    virtual bool send();
79  protected:
80    Packet();
81    Packet(uint8_t *data, unsigned int clientID);
82//    Packet(ENetPacket *packet, ENetPeer *peer);
83    inline bool isDataENetAllocated() const
84      { return bDataENetAllocated_; }
85
86    uint32_t flags_;
87    unsigned int clientID_;
88    Direction::Value packetDirection_;
89    /** Pointer to the data. Be careful when deleting it because it might
90        point to a location that was allocated by ENet.
91        See bDataENetAllocated_ */
92    uint8_t *data_;
93    /** Tells whether data_ was allocated by ENet or ourselves.
94        data_ might no correlate with enetPacket_->data. */
95    bool bDataENetAllocated_;
96  private:
97    static std::map<size_t, Packet *> packetMap_;
98    ENetPacket *enetPacket_;
99};
100
101} //namespace packet
102
103} //namespace orxonox
104
105#endif /* _NETWORK_Packet_H__ */
Note: See TracBrowser for help on using the repository browser.