clientpacket.h

/***************************************************************************
 * 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....                                                          *
 *                                                                         *
 ***************************************************************************/
#ifndef CLIENTPACKET_H
#define CLIENTPACKET_H

#include "../common/frameworkpacket.h"

template<class PacketType>
class Plugin;

class ClientFramework;
class ClientData;

/**
 * @ingroup Client
 * @brief This packet is used from the client-side when sending/receiving packets.
 *
 * @author Lars Langer and Emanuel Greisen
 */
class ClientPacket : public FrameworkPacket
{
private:
   ClientFramework * framework;

protected:
   /// Constructor used when client-data is signaling back.
   ClientPacket(ClientFramework * f, unsigned int receiver, unsigned char type=4, unsigned char priority=1, unsigned int bodysize=INITIAL_BODY_SIZE, bool reliable=false);

public:
   /// Constructor used when receiving packets.
   ClientPacket(char * data, unsigned int size);
   /// Constructor used when client-data is signaling back.
   ClientPacket(const ClientData * fdata, unsigned char type=4, unsigned char priority=1, bool reliable=false);
   ~ClientPacket();

public:
   /// This will create an ack-packet.
   static ClientPacket * createAckPacket(ClientPacket * packet);
   static ClientPacket * createDummyPacket( );
   static ClientPacket * createSystemPacket(ClientFramework * f, FrameworkPacket::SpecialReceivers receiver );
   /// Will create a plugin packet from a plugin.
   static ClientPacket * createPluginPacket( const Plugin<ClientPacket> * plugin, const ClientPacket * _packet );



public:
   /// This method makes the packet ready for sending (htonl(...) is called on header fields).
   void makeSendReady();
   /// Will return the ID of the user for whom that packet is from/to.
   unsigned int getUserID() const { return 0; }; // The server has 0 as id

///@name Readers
///@throws PacketError is thrown if you try to read beyond the size of the packet.
/// <p>
/// The following methods are used when reading from a packet.
///@{
public:
   /// The class T must be a subclass of ClientData.
   template<class T>
   void readPtr(ClientData * receiver, T ** ptrptr, ClientFramework * framework);
   /// The class T must be a subclass of ClientData.
   template<class T>
   T * readObject(ClientFramework * f);
   /// This method will create a new packet of size psize from current possition.
   ClientPacket * readPacket(unsigned int psize);
   ///@}

};

#endif

---