/* * ORXONOX - the hottest 3D action shooter ever to exist * > www.orxonox.net < * * * License notice: * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * * Author: * Oliver Scheuss, (C) 2008 * Co-authors: * ... * */ #include "Packet.h" #include #include #define WIN32_LEAN_AND_MEAN #include #include #include "util/Debug.h" #include "Acknowledgement.h" #include "Chat.h" #include "ClassID.h" #include "DeleteObjects.h" #include "FunctionCalls.h" #include "FunctionIDs.h" #include "Gamestate.h" #include "Welcome.h" #include "network/Host.h" #include "network/ClientInformation.h" namespace orxonox{ namespace packet{ // Make sure we assume the right values BOOST_STATIC_ASSERT(static_cast(PacketFlag::Reliable) == static_cast(ENET_PACKET_FLAG_RELIABLE)); BOOST_STATIC_ASSERT(static_cast(PacketFlag::Unsequence) == static_cast(ENET_PACKET_FLAG_UNSEQUENCED)); BOOST_STATIC_ASSERT(static_cast(PacketFlag::NoAllocate) == static_cast(ENET_PACKET_FLAG_NO_ALLOCATE)); #define PACKET_FLAG_DEFAULT PacketFlag::NoAllocate #define _PACKETID 0 std::map Packet::packetMap_; Packet::Packet(){ flags_ = PACKET_FLAG_DEFAULT; packetDirection_ = Direction::Outgoing; clientID_=0; data_=0; enetPacket_=0; bDataENetAllocated_ = false; } void blub(ENetPacket *packet){ COUT(4) << "blubb" << std::endl; } Packet::Packet(uint8_t *data, unsigned int clientID){ flags_ = PACKET_FLAG_DEFAULT; packetDirection_ = Direction::Incoming; clientID_=clientID; data_=data; enetPacket_=0; bDataENetAllocated_ = false; } Packet::Packet(const Packet &p){ enetPacket_=p.enetPacket_; flags_=p.flags_; packetDirection_ = p.packetDirection_; clientID_ = p.clientID_; if(p.data_){ data_ = new uint8_t[p.getSize()]; memcpy(data_, p.data_, p.getSize()); }else data_=0; bDataENetAllocated_ = p.bDataENetAllocated_; } /** @brief Destroys a packet completely. That also means destroying the ENetPacket if one exists. There */ Packet::~Packet(){ // Deallocate data_ memory if necessary. if (this->bDataENetAllocated_){ // In this case ENet allocated data_ and will destroy it. } else if (this->data_) { // This destructor was probably called as a consequence of ENet executing our callback. // It simply serves us to be able to deallocate the packet content (data_) ourselves since // we have created it in the first place. delete[] this->data_; } // Destroy the ENetPacket if necessary. // Note: For the case ENet used the callback to destroy the packet, we have already set // enetPacket_ to NULL to avoid destroying it again. if (this->enetPacket_){ // enetPacket_->data gets destroyed too by ENet if it was allocated by it. enet_packet_destroy(enetPacket_); } } bool Packet::send(){ if(packetDirection_ != Direction::Outgoing && packetDirection_ != Direction::Bidirectional ){ assert(0); return false; } if(!enetPacket_){ if(!data_){ assert(0); return false; } // We deliver ENet the data address so that it doesn't memcpy everything again. // --> We have to delete data_ ourselves! enetPacket_ = enet_packet_create(getData(), getSize(), getFlags()); enetPacket_->freeCallback = &Packet::deletePacket; // Add the packet to a global list so we can access it again once enet calls our // deletePacket method. We can of course only give a one argument function to the ENet C library. { // Assures we don't create a packet and destroy it right after in another thread // without having a reference in the packetMap_ packetMap_[reinterpret_cast(enetPacket_)] = this; } } #ifndef NDEBUG switch( *(Type::Value *)(data_ + _PACKETID) ) { case Type::Acknowledgement: case Type::Chat: case Type::ClassID: case Type::Gamestate: case Type::Welcome: case Type::DeleteObjects: case Type::FunctionIDs: case Type::FunctionCalls: break; default: assert(0); //there was some error, if this is the case break; } #endif // ENetPacket *temp = enetPacket_; // enetPacket_ = 0; // otherwise we have a double free because enet already handles the deallocation of the packet if(!Host::addPacket( enetPacket_, clientID_)) enet_packet_destroy(this->enetPacket_); // if we could not add the packet to the enet queue delete it manually return true; } Packet *Packet::createPacket(ENetPacket *packet, ENetPeer *peer){ uint8_t *data = packet->data; assert(ClientInformation::findClient(&peer->address)->getID() != static_cast(-2) || !Host::isServer()); unsigned int clientID = ClientInformation::findClient(&peer->address)->getID(); Packet *p = 0; COUT(6) << "packet type: " << *(Type::Value *)&data[_PACKETID] << std::endl; switch( *(Type::Value *)(data + _PACKETID) ) { case Type::Acknowledgement: COUT(5) << "ack" << std::endl; p = new Acknowledgement( data, clientID ); break; case Type::Chat: COUT(5) << "chat" << std::endl; p = new Chat( data, clientID ); break; case Type::ClassID: COUT(5) << "classid" << std::endl; p = new ClassID( data, clientID ); break; case Type::Gamestate: COUT(5) << "gamestate" << std::endl; // TODO: remove brackets p = new Gamestate( data, clientID ); break; case Type::Welcome: COUT(5) << "welcome" << std::endl; p = new Welcome( data, clientID ); break; case Type::DeleteObjects: COUT(5) << "deleteobjects" << std::endl; p = new DeleteObjects( data, clientID ); break; case Type::FunctionCalls: COUT(5) << "functionCalls" << std::endl; p = new FunctionCalls( data, clientID ); break; case Type::FunctionIDs: COUT(5) << "functionIDs" << std::endl; p = new FunctionIDs( data, clientID ); break; default: assert(0); //TODO: repair this break; } // Data was created by ENet p->bDataENetAllocated_ = true; p->enetPacket_ = packet; return p; } /** @brief ENet calls this method whenever it wants to destroy a packet that contains data we allocated ourselves. */ void Packet::deletePacket(ENetPacket *enetPacket){ // Get our Packet from a global map with all Packets created in the send() method of Packet. std::map::iterator it = packetMap_.find(reinterpret_cast(enetPacket)); assert(it != packetMap_.end()); // Make sure we don't delete it again in the destructor it->second->enetPacket_ = 0; delete it->second; packetMap_.erase(it); COUT(6) << "PacketMap size: " << packetMap_.size() << std::endl; } } // namespace packet } // namespace orxonox