Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 7725 was 7163, checked in by dafrick, 14 years ago

Merged presentation3 branch into trunk.

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