Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

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

Reverted trunk again. We might want to find a way to delete these revisions again (x3n's changes are still available as diff in the commit mails).

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