Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/network/packet/Packet.cc @ 3006

Last change on this file since 3006 was 2773, checked in by rgrieder, 16 years ago

Removed all enet and boost includes from header files in the network library.

  • Reduces dependencies
  • Minimises problems with windows.h
  • Speeds up the compiling process a little bit (probably negligible)
  • Also removes ugly WIN32_LEAN_AND_MEAN declarations before every enet.h include in the network library.

Removed windows.h header from util/Sleep.h by adding Sleep.cc

  • Property svn:eol-style set to native
File size: 6.7 KB
RevLine 
[1711]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) 2008
24 *   Co-authors:
25 *      ...
26 *
27 */
[1701]28
[1711]29
[1760]30#include "Packet.h"
31
32#include <cassert>
[1701]33#include <enet/enet.h>
[1711]34#include <boost/bind.hpp>
[2773]35#include <boost/thread/recursive_mutex.hpp>
[1701]36
37#include "network/ConnectionManager.h"
38#include "network/ClientInformation.h"
39
40#include "Acknowledgement.h"
41#include "Chat.h"
42#include "ClassID.h"
[1709]43#include "Gamestate.h"
[1711]44#include "Welcome.h"
[1907]45#include "DeleteObjects.h"
[1701]46#include "network/Host.h"
[1705]47#include "core/CoreIncludes.h"
[1701]48
[2171]49namespace orxonox{
[1701]50
51namespace packet{
[2087]52
[1711]53#define PACKET_FLAG_DEFAULT ENET_PACKET_FLAG_NO_ALLOCATE
[1701]54#define _PACKETID           0
[2087]55
[2171]56std::map<size_t, Packet *> Packet::packetMap_;
[2773]57//! Static mutex for any packetMap_ access
58static boost::recursive_mutex packetMap_mutex_g;
[2087]59
[1701]60Packet::Packet(){
[1711]61  flags_ = PACKET_FLAG_DEFAULT;
[1701]62  packetDirection_ = ENUM::Outgoing;
63  clientID_=0;
[1711]64  data_=0;
[1701]65  enetPacket_=0;
[2087]66  bDataENetAllocated_ = false;
[1701]67}
68
[1712]69void blub(ENetPacket *packet){
[1713]70  COUT(4) << "blubb" << std::endl;
[1712]71}
72
[1907]73Packet::Packet(uint8_t *data, unsigned int clientID){
[1711]74  flags_ = PACKET_FLAG_DEFAULT;
[1713]75  packetDirection_ = ENUM::Incoming;
[1711]76  clientID_=clientID;
77  data_=data;
[1701]78  enetPacket_=0;
[2087]79  bDataENetAllocated_ = false;
[1701]80}
81
82
[1711]83Packet::Packet(const Packet &p){
[1712]84  enetPacket_=p.enetPacket_;
[1711]85  flags_=p.flags_;
[1730]86  packetDirection_ = p.packetDirection_;
87  clientID_ = p.clientID_;
[1711]88  if(p.data_){
[1907]89    data_ = new uint8_t[p.getSize()];
[1711]90    memcpy(data_, p.data_, p.getSize());
91  }else
92    data_=0;
[2087]93  bDataENetAllocated_ = p.bDataENetAllocated_;
[1701]94}
95
[2087]96/**
97@brief
98    Destroys a packet completely.
99   
100    That also means destroying the ENetPacket if one exists. There
101*/
[1711]102Packet::~Packet(){
[2087]103  // Deallocate data_ memory if necessary.
104  if (this->bDataENetAllocated_){
105    // In this case ENet allocated data_ and will destroy it.
106  }
107  else if (this->data_) {
108    // This destructor was probably called as a consequence to ENet executing our callback.
109    // It simply serves us to be able to deallocate the packet content (data_) ourselves since
110    // we have created it in the first place.
111    delete[] this->data_;
112  }
113
114  // Destroy the ENetPacket if necessary.
115  // Note: For the case ENet used the callback to destroy the packet, we have already set
116  // enetPacket_ to NULL to avoid destroying it again.
117  if (this->enetPacket_){
118    // enetPacket_->data gets destroyed too by ENet if it was allocated by it.
[1705]119    enet_packet_destroy(enetPacket_);
[1751]120  }
[1705]121}
[1701]122
123bool Packet::send(){
[1730]124  if(packetDirection_ != ENUM::Outgoing && packetDirection_ != ENUM::Bidirectional ){
[1712]125    assert(0);
[1701]126    return false;
[1730]127  }
[1701]128  if(!enetPacket_){
[1712]129    if(!data_){
130      assert(0);
[1701]131      return false;
[1712]132    }
[2087]133    // We deliver ENet the data address so that it doesn't memcpy everything again.
134    // --> We have to delete data_ ourselves!
[1711]135    enetPacket_ = enet_packet_create(getData(), getSize(), getFlags());
[1751]136    enetPacket_->freeCallback = &Packet::deletePacket;
[2087]137    // Add the packet to a global list so we can access it again once enet calls our
138    // deletePacket method. We can of course only give a one argument function to the ENet C library.
[2662]139    {
140      // Assures we don't create a packet and destroy it right after in another thread
141      // without having a reference in the packetMap_
[2773]142      boost::recursive_mutex::scoped_lock lock(packetMap_mutex_g);
[2662]143      packetMap_[(size_t)(void*)enetPacket_] = this;
144    }
[1701]145  }
[2087]146#ifndef NDEBUG
[1751]147  switch( *(ENUM::Type *)(data_ + _PACKETID) )
[1715]148  {
149    case ENUM::Acknowledgement:
150    case ENUM::Chat:
151    case ENUM::ClassID:
152    case ENUM::Gamestate:
153    case ENUM::Welcome:
[1907]154    case ENUM::DeleteObjects:
[1751]155      break;
[1715]156    default:
[1751]157      assert(0); //there was some error, if this is the case
[1715]158      break;
[1751]159  }
160#endif
[2087]161//  ENetPacket *temp = enetPacket_;
162//  enetPacket_ = 0; // otherwise we have a double free because enet already handles the deallocation of the packet
[2171]163  Host::addPacket( enetPacket_, clientID_);
[1701]164  return true;
165}
166
[1711]167Packet *Packet::createPacket(ENetPacket *packet, ENetPeer *peer){
[1907]168  uint8_t *data = packet->data;
[2087]169  assert(ClientInformation::findClient(&peer->address)->getID() != (unsigned int)-2 || !Host::isServer());
[1711]170  unsigned int clientID = ClientInformation::findClient(&peer->address)->getID();
[2710]171  Packet *p = 0;
[1907]172  COUT(5) << "packet type: " << *(ENUM::Type *)&data[_PACKETID] << std::endl;
[1715]173  switch( *(ENUM::Type *)(data + _PACKETID) )
[1701]174  {
175    case ENUM::Acknowledgement:
[1907]176      COUT(4) << "ack" << std::endl;
[1711]177      p = new Acknowledgement( data, clientID );
[1701]178      break;
179    case ENUM::Chat:
[1907]180      COUT(4) << "chat" << std::endl;
[1711]181      p = new Chat( data, clientID );
[1701]182      break;
183    case ENUM::ClassID:
[1907]184      COUT(4) << "classid" << std::endl;
[1711]185      p = new ClassID( data, clientID );
[1701]186      break;
187    case ENUM::Gamestate:
[1907]188      COUT(4) << "gamestate" << std::endl;
[1701]189      // TODO: remove brackets
[1715]190      p = new Gamestate( data, clientID );
[1701]191      break;
[1711]192    case ENUM::Welcome:
[1907]193      COUT(4) << "welcome" << std::endl;
[1711]194      p = new Welcome( data, clientID );
[1715]195      break;
[1907]196    case ENUM::DeleteObjects:
197      COUT(4) << "deleteobjects" << std::endl;
198      p = new DeleteObjects( data, clientID );
199      break;
[1701]200    default:
[1710]201      assert(0); //TODO: repair this
202      break;
[1701]203  }
[2087]204
205  // Data was created by ENet
206  p->bDataENetAllocated_ = true;
207
[1711]208  return p;
[1701]209}
210
[2087]211/**
212@brief
213    ENet calls this method whenever it wants to destroy a packet that contains
214    data we allocated ourselves.
215*/
216void Packet::deletePacket(ENetPacket *enetPacket){
[2773]217  boost::recursive_mutex::scoped_lock lock(packetMap_mutex_g);
[2087]218  // Get our Packet from a gloabal map with all Packets created in the send() method of Packet.
[2171]219  std::map<size_t, Packet*>::iterator it = packetMap_.find((size_t)enetPacket);
[2087]220  assert(it != packetMap_.end());
221  // Make sure we don't delete it again in the destructor
222  it->second->enetPacket_ = 0;
223  delete it->second;
[2171]224  packetMap_.erase(it);
[2087]225  COUT(4) << "PacketMap size: " << packetMap_.size() << std::endl;
[1711]226}
227
[1701]228} // namespace packet
229
[2171]230} // namespace orxonox
[1701]231
Note: See TracBrowser for help on using the repository browser.