Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 9541 was 8858, checked in by landauf, 13 years ago

merged output branch back to trunk.

Changes:

  • you have to include util/Output.h instead of util/Debug.h
  • COUT(x) is now called orxout(level)
  • output levels are now defined by an enum instead of numbers. see util/Output.h for the definition
  • it's possible to use output contexts with orxout(level, context). see util/Output.h for some common contexts. you can define more contexts
  • you must use 'endl' at the end of an output message, '\n' does not flush the message

Output levels:

  • instead of COUT(0) use orxout()
  • instead of COUT(1) use orxout(user_error) or orxout(internal_error)
  • instead of COUT(2) use orxout(user_warning) or orxout(internal_warning)
  • instead of COUT(3) use orxout(user_status/user_info) or orxout(internal_status/internal_info)
  • instead of COUT(4) use orxout(verbose)
  • instead of COUT(5) use orxout(verbose_more)
  • instead of COUT(6) use orxout(verbose_ultra)

Guidelines:

  • user_* levels are for the user, visible in the console and the log-file
  • internal_* levels are for developers, visible in the log-file
  • verbose_* levels are for debugging, only visible if the context of the output is activated

Usage in C++:

  • orxout() << "message" << endl;
  • orxout(level) << "message" << endl;
  • orxout(level, context) << "message" << endl;

Usage in Lua:

  • orxout("message")
  • orxout(orxonox.level.levelname, "message")
  • orxout(orxonox.level.levelname, "context", "message")

Usage in Tcl (and in the in-game-console):

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