serverpacket.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 SERVERPACKET_H
#define SERVERPACKET_H

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

template<class PacketType>
class Plugin;
class ServerData;

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

private:
   ServerPacket(unsigned int receiver,unsigned char type=4,unsigned char priority=0,unsigned int bodysize=INITIAL_BODY_SIZE, bool reliable=false);
public:
   /// Constructor used when receiving packets.
   ServerPacket(char * data, unsigned int size);

   ServerPacket(const ServerData * fdata,unsigned char type,unsigned char priority,bool reliable);
   ~ServerPacket();

public:
   /// This will init a "Create-object" packet
   static ServerPacket * initCreateObjectPacket(const ServerData * fdata, unsigned char prio);
   /// This will init a "Destroy-object" packet
   static ServerPacket * initDestroyObjectPacket(const ServerData * fdata, unsigned char prio);
   /// Used to ack packets
   static ServerPacket * createAckPacket( ServerPacket * packet );
   /// Will create an empty dummy packet ready for writing into.
   static ServerPacket * createDummyPacket();
   /// Will create a system packet.
   static ServerPacket * createSystemPacket( FrameworkPacket::SpecialReceivers receiver );
   /// Will create a plugin packet from a plugin.
   static ServerPacket * createPluginPacket( const Plugin<ServerPacket> * plugin, const ServerPacket * packet);

public:
   /// This method makes the packet ready for sending (htonl(...) is called on header fields).
   void makeSendReady();
   /// Will return the id of the client for whom this packet is to/from.
   unsigned int getUserID() const { return client ? client->getId() : 0; }; // If we have no receiver, we just return 0

///@name Writers
///@throws PacketError is thrown if you try to write beyond the hard-coded max-size of the packet.
/// <p>
/// The following methods are used when writing to a packet.
///@{
public:
   void writePtr( const ServerData * obj );
   void writeObject( const ServerData * obj );
///@}

///@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:
   /// This method will create a new packet of size psize from current possition.
   ServerPacket * readPacket(unsigned int psize);
///@}

};

#endif

---