clientpacket.cpp

/***************************************************************************
 * The contents of this file are subject to the Mozilla Public             *
 * License Version 1.1 (the "License"); you may not use this file          *
 * except in compliance with the License. You may obtain a copy of         *
 * the License at http://www.mozilla.org/MPL/                              *
 *                                                                         *
 * Software distributed under the License is distributed on an "AS         *
 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or              *
 * implied. See the License for the specific language governing            *
 * rights and limitations under the License.                               *
 *                                                                         *
 * The Original Code is Game Network Framework (GaNeF).                    *
 *                                                                         *
 * The Initial Developers of the Original Code are                         *
 * Lars Langer and Emanuel Greisen                                         *
 * Copyright (C) 2005. Lars Langer & Emanuel Greisen                       *
 * All Rights Reserved.                                                    *
 *                                                                         *
 * Contributor(s):                                                         *
 *   none yet....                                                          *
 *                                                                         *
 ***************************************************************************/
#include "clientpacket.h"

#include "clientdata.h"

#include "../common/plugin.h"

ClientPacket::ClientPacket(const ClientData * fdata, unsigned char type, unsigned char priority, bool reliable) :
   framework(fdata->getFramework()),
   FrameworkPacket(fdata->getFrameworkId(),type,priority,INITIAL_BODY_SIZE,reliable)
{
   // Check type is not system r plugin
   if(type < 4)
      throw new PacketError("Type is below 4, user defined messages must be type: 4-255");
}

ClientPacket::ClientPacket(ClientFramework * f, unsigned int receiver, unsigned char type, unsigned char priority, unsigned int bodysize, bool reliable ) :
      framework(f),
      FrameworkPacket(receiver,type,priority,bodysize,reliable)
{
}

ClientPacket::ClientPacket( char * data, unsigned int size) :
      FrameworkPacket(data,size)
{
}



ClientPacket::~ClientPacket()
{
}

ClientPacket * ClientPacket::createDummyPacket( )
{
   return createSystemPacket(NULL, DUMMY_PACKET );
}

ClientPacket * ClientPacket::createSystemPacket(ClientFramework * f, FrameworkPacket::SpecialReceivers receiver )
{
   ClientPacket * packet = new ClientPacket(f, receiver, 0);
   packet->header->reliable = 1;
   return packet;
}

ClientPacket * ClientPacket::createAckPacket( ClientPacket * packet )
{
   // Create a packet of type 0(system), with receiver PACKET_ACK, the same priority, a bodysize of 5 and unreliable.
   ClientPacket * ack = new ClientPacket(NULL, PACKET_ACK, 0, packet->getPriority(), 5, false);
   ack->peer = packet->peer;
   ack->writeUInt32(packet->getSequenceNumber());
   ack->writeUInt8(packet->getPriority());
   return ack;
}

ClientPacket * ClientPacket::createPluginPacket( const Plugin<ClientPacket> * plugin, const ClientPacket * _packet  )
{
   ClientPacket * packet = new ClientPacket(NULL, plugin->getUniqueId(),1,0,INITIAL_BODY_SIZE,true);
   packet->peer = _packet->peer;
   return packet;
}

ClientPacket * ClientPacket::readPacket( unsigned int psize )
{
   before_read_check(psize);
   ClientPacket * pack = new ClientPacket(&data[pos], psize);
   pack->peer = peer;
   pos += psize;
   return pack;
}


void ClientPacket::makeSendReady( )
{
   if(!packet_ready_to_transmit)
   {
      if(!header->reliable && !isAckPacket())
      {
         // Get the next sequence number
         header->packet_seq_number = framework->getNextUnreliablePacketSeqNumber(this);
      }
      header->receiver = htonl(header->receiver);
      header->packet_seq_number = htonl(header->packet_seq_number);
      packet_ready_to_transmit = true;
   }
}

---