Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 6417 was 6417, checked in by rgrieder, 14 years ago

Merged presentation2 branch back to trunk.
Major new features:

  • Actual GUI with settings, etc.
  • Improved space ship steering (human interaction)
  • Rocket fire and more particle effects
  • Advanced sound framework
  • Property svn:eol-style set to native
File size: 7.4 KB
Line 
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 */
28
29
30#include "Packet.h"
31
32#include <cassert>
33#include <cstring>
34#define WIN32_LEAN_AND_MEAN
35#include <enet/enet.h>
36#include <boost/static_assert.hpp>
37
38#include "util/Debug.h"
39#include "Acknowledgement.h"
40#include "Chat.h"
41#include "ClassID.h"
42#include "DeleteObjects.h"
43#include "FunctionCalls.h"
44#include "FunctionIDs.h"
45#include "Gamestate.h"
46#include "Welcome.h"
47#include "network/Host.h"
48#include "network/ClientInformation.h"
49
50namespace orxonox{
51
52namespace packet{
53
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
60#define _PACKETID           0
61
62std::map<size_t, Packet *> Packet::packetMap_;
63
64Packet::Packet(){
65  flags_ = PACKET_FLAG_DEFAULT;
66  packetDirection_ = Direction::Outgoing;
67  clientID_=0;
68  data_=0;
69  enetPacket_=0;
70  bDataENetAllocated_ = false;
71}
72
73void blub(ENetPacket *packet){
74  COUT(4) << "blubb" << std::endl;
75}
76
77Packet::Packet(uint8_t *data, unsigned int clientID){
78  flags_ = PACKET_FLAG_DEFAULT;
79  packetDirection_ = Direction::Incoming;
80  clientID_=clientID;
81  data_=data;
82  enetPacket_=0;
83  bDataENetAllocated_ = false;
84}
85
86
87Packet::Packet(const Packet &p){
88  enetPacket_=p.enetPacket_;
89  flags_=p.flags_;
90  packetDirection_ = p.packetDirection_;
91  clientID_ = p.clientID_;
92  if(p.data_){
93    data_ = new uint8_t[p.getSize()];
94    memcpy(data_, p.data_, p.getSize());
95  }else
96    data_=0;
97  bDataENetAllocated_ = p.bDataENetAllocated_;
98}
99
100/**
101@brief
102    Destroys a packet completely.
103
104    That also means destroying the ENetPacket if one exists. There
105*/
106Packet::~Packet(){
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_) {
112    // This destructor was probably called as a consequence of ENet executing our callback.
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.
123    enet_packet_destroy(enetPacket_);
124  }
125}
126
127bool Packet::send(){
128  if(packetDirection_ != Direction::Outgoing && packetDirection_ != Direction::Bidirectional ){
129    assert(0);
130    return false;
131  }
132  if(!enetPacket_){
133    if(!data_){
134      assert(0);
135      return false;
136    }
137    // We deliver ENet the data address so that it doesn't memcpy everything again.
138    // --> We have to delete data_ ourselves!
139    enetPacket_ = enet_packet_create(getData(), getSize(), getFlags());
140    enetPacket_->freeCallback = &Packet::deletePacket;
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.
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_
146      packetMap_[reinterpret_cast<size_t>(enetPacket_)] = this;
147    }
148  }
149#ifndef NDEBUG
150  switch( *(Type::Value *)(data_ + _PACKETID) )
151  {
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:
160      break;
161    default:
162      assert(0); //there was some error, if this is the case
163      break;
164  }
165#endif
166//  ENetPacket *temp = enetPacket_;
167//  enetPacket_ = 0; // otherwise we have a double free because enet already handles the deallocation of the packet
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
170  return true;
171}
172
173Packet *Packet::createPacket(ENetPacket *packet, ENetPeer *peer){
174  uint8_t *data = packet->data;
175  assert(ClientInformation::findClient(&peer->address)->getID() != static_cast<unsigned int>(-2) || !Host::isServer());
176  unsigned int clientID = ClientInformation::findClient(&peer->address)->getID();
177  Packet *p = 0;
178  COUT(6) << "packet type: " << *(Type::Value *)&data[_PACKETID] << std::endl;
179  switch( *(Type::Value *)(data + _PACKETID) )
180  {
181    case Type::Acknowledgement:
182      COUT(5) << "ack" << std::endl;
183      p = new Acknowledgement( data, clientID );
184      break;
185    case Type::Chat:
186      COUT(5) << "chat" << std::endl;
187      p = new Chat( data, clientID );
188      break;
189    case Type::ClassID:
190      COUT(5) << "classid" << std::endl;
191      p = new ClassID( data, clientID );
192      break;
193    case Type::Gamestate:
194      COUT(5) << "gamestate" << std::endl;
195      // TODO: remove brackets
196      p = new Gamestate( data, clientID );
197      break;
198    case Type::Welcome:
199      COUT(5) << "welcome" << std::endl;
200      p = new Welcome( data, clientID );
201      break;
202    case Type::DeleteObjects:
203      COUT(5) << "deleteobjects" << std::endl;
204      p = new DeleteObjects( data, clientID );
205      break;
206    case Type::FunctionCalls:
207      COUT(5) << "functionCalls" << std::endl;
208      p = new FunctionCalls( data, clientID );
209      break;
210    case Type::FunctionIDs:
211      COUT(5) << "functionIDs" << std::endl;
212      p = new FunctionIDs( data, clientID );
213      break;
214    default:
215      assert(0); //TODO: repair this
216      break;
217  }
218
219  // Data was created by ENet
220  p->bDataENetAllocated_ = true;
221  p->enetPacket_ = packet;
222
223  return p;
224}
225
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 global map with all Packets created in the send() method of Packet.
233  std::map<size_t, Packet*>::iterator it = packetMap_.find(reinterpret_cast<size_t>(enetPacket));
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;
238  packetMap_.erase(it);
239  COUT(6) << "PacketMap size: " << packetMap_.size() << std::endl;
240}
241
242} // namespace packet
243
244} // namespace orxonox
245
Note: See TracBrowser for help on using the repository browser.