Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/mergeFS18/src/libraries/network/packet/Packet.cc @ 12325

Last change on this file since 12325 was 12027, checked in by merholzl, 6 years ago

Merged Masterserver, refresh button had to be removed

  • Property svn:eol-style set to native
File size: 7.0 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/thread/mutex.hpp>
37
38#include "util/Output.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
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");
58
59#define PACKET_FLAG_DEFAULT PacketFlag::NoAllocate
60#define _PACKETID           0
61
62std::map<size_t, Packet *> Packet::packetMap_;
63boost::mutex Packet::packetMapMutex_;
64
65Packet::Packet()
66{
67  flags_ = PACKET_FLAG_DEFAULT;
68  packetDirection_ = Direction::Outgoing;
69  peerID_=0;
70  data_=nullptr;
71  enetPacket_=nullptr;
72  bDataENetAllocated_ = false;
73}
74
75Packet::Packet(uint8_t *data, unsigned int peerID)
76{
77  flags_ = PACKET_FLAG_DEFAULT;
78  packetDirection_ = Direction::Incoming;
79  peerID_=peerID;
80  data_=data;
81  enetPacket_=nullptr;
82  bDataENetAllocated_ = false;
83}
84
85
86Packet::Packet(const Packet &p)
87{
88  enetPacket_=p.enetPacket_;
89  flags_=p.flags_;
90  packetDirection_ = p.packetDirection_;
91  peerID_ = p.peerID_;
92  if(p.data_){
93    data_ = new uint8_t[p.getSize()];
94    memcpy(data_, p.data_, p.getSize());
95  }else
96    data_=nullptr;
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{
108  // Deallocate data_ memory if necessary.
109  if (this->bDataENetAllocated_)
110  {
111    // In this case ENet allocated data_ and will destroy it.
112  }
113  else if (this->data_)
114  {
115    // This destructor was probably called as a consequence of ENet executing our callback.
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
123  // enetPacket_ to nullptr to avoid destroying it again.
124  if (this->enetPacket_)
125  {
126    // enetPacket_->data gets destroyed too by ENet if it was allocated by it.
127    enet_packet_destroy(enetPacket_);
128  }
129}
130
131/**
132 * Send the Packet.
133 * @param host The host which sends the packet
134 */
135bool Packet::send(orxonox::Host* host)
136{
137  // Deny sending incoming packets
138  if(packetDirection_ != Direction::Outgoing && packetDirection_ != Direction::Bidirectional )
139  {
140    assert(0);
141    return false;
142  }
143
144  if(!enetPacket_)
145  {
146    // Deny sending empty packets
147    if(!data_) {
148      assert(0);
149      return false;
150    }
151    // We deliver ENet the data address so that it doesn't memcpy everything again.
152    // --> We have to delete data_ ourselves!
153    enetPacket_ = enet_packet_create(getData(), getSize(), getFlags());
154    enetPacket_->freeCallback = &Packet::deletePacket;
155    // Add the packet to a global list so we can access it again once enet calls our
156    // deletePacket method. We can of course only give a one argument function to the ENet C library.
157    {
158      // Assures we don't create a packet and destroy it right after in another thread
159      // without having a reference in the packetMap_
160      Packet::packetMapMutex_.lock();
161      Packet::packetMap_[reinterpret_cast<size_t>(enetPacket_)] = this;
162      Packet::packetMapMutex_.unlock();
163    }
164  }
165#ifndef NDEBUG
166  switch( *(Type *)(data_ + _PACKETID) )
167  {
168    case Type::Acknowledgement:
169    case Type::Chat:
170    case Type::ClassID:
171    case Type::Gamestate:
172    case Type::Welcome:
173    case Type::DeleteObjects:
174    case Type::FunctionIDs:
175    case Type::FunctionCalls:
176      break;
177    default:
178      assert(0); //there was some error, if this is the case
179      break;
180  }
181#endif
182
183  // Send via reliable or standard channel respectively
184  if( this->flags_ & PacketFlag::Reliable )
185    host->addPacket( enetPacket_, peerID_, NETWORK_CHANNEL_DEFAULT);
186  else
187    host->addPacket( enetPacket_, peerID_, NETWORK_CHANNEL_UNRELIABLE);
188
189  return true;
190}
191
192/**
193 * Given an ENetPacket, create an Orxonox packet
194 * @param packet The ENetPacket
195 * @param peerID The sender
196 */
197Packet *Packet::createPacket(ENetPacket* packet, uint32_t peerID)
198{
199  uint8_t *data = packet->data;
200  Packet *p = nullptr;
201  switch( *(Type *)(data + _PACKETID) )
202  {
203    case Type::Acknowledgement:
204      p = new Acknowledgement( data, peerID );
205      break;
206    case Type::Chat:
207      p = new Chat( data, peerID );
208      break;
209    case Type::ClassID:
210      p = new ClassID( data, peerID );
211      break;
212    case Type::Gamestate:
213      p = new Gamestate( data, peerID );
214      break;
215    case Type::Welcome:
216      p = new Welcome( data, peerID );
217      break;
218    case Type::DeleteObjects:
219      p = new DeleteObjects( data, peerID );
220      break;
221    case Type::FunctionCalls:
222      p = new FunctionCalls( data, peerID );
223      break;
224    case Type::FunctionIDs:
225      p = new FunctionIDs( data, peerID );
226      break;
227    default:
228      assert(0);
229      break;
230  }
231
232  // Data was created by ENet
233  p->bDataENetAllocated_ = true;
234  p->enetPacket_ = packet;
235
236  return p;
237}
238
239/**
240@brief
241    ENet calls this method whenever it wants to destroy a packet that contains
242    data we allocated ourselves.
243*/
244void Packet::deletePacket(ENetPacket *enetPacket)
245{
246  // Get our Packet from a global map with all Packets created in the send() method of Packet.
247  Packet::packetMapMutex_.lock();
248
249  std::map<size_t, Packet*>::iterator it = Packet::packetMap_.find(reinterpret_cast<size_t>(enetPacket));
250  assert(it != packetMap_.end());
251
252  // Make sure we don't delete it again in the destructor
253  it->second->enetPacket_ = nullptr;
254  delete it->second;
255  packetMap_.erase(it);
256
257  Packet::packetMapMutex_.unlock();
258}
259
260} // namespace packet
261
262} // namespace orxonox
263
Note: See TracBrowser for help on using the repository browser.