Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 11703 was 11071, checked in by landauf, 9 years ago

merged branch cpp11_v3 back to trunk

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