serverdata.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 SERVERDATA_H
#define SERVERDATA_H

#include <map>

#include <ptypes.h>

#include "serverpacket.h"
#include "../common/frameworkdata.h"

template<class PacketType, class SocketType>
class PendingAck;
class ServerFramework;
class Client;

/// @example testserver/testserversnakebite.h
/**
 * @ingroup Server
 * @brief This is the interface implemented by all data residing on the server.
 * When your data-classes inherit from this class they must implement the fillXXX methods. This is how the packets used to update/construct a client version of the object are created.
 *
 * <p>
 * OPTIMIZE: we could enqueue the packet directly if there is only one receiver in the client-list
 *
 * @author Lars Langer & Emanuel Greisen
 */
class ServerData : public FrameworkData
{
private:
   ServerFramework * server_frame_work;
   const char _packet_priority;
   bool _packet_reliable;
   static unsigned int next_data_id;
   static mutex next_data_id_mutex;
   static unsigned int nextDataId();

public:
   ServerData(ServerFramework * f, char packet_priority, bool packet_reliable);
   ~ServerData();

public:
   /// Will send a create-object packet to all clients.
   void sendCreateObjectToAll() const;
   /// Creates and sends a create-object packet to a list of clients.
   void sendCreateObject(const std::map<unsigned int, Client *> & clientlist) const;
   void sendCreateObject( Client * client) const;

   /// Will send an update packet to all clients.
   void sendUpdateToAll(unsigned char type, bool reliable) const;
   /// Creates and sends an update packet to a list of clients.
   void sendUpdate(const std::map<unsigned int, Client *> & clientlist, unsigned char type, bool reliable) const;
   void sendUpdate( Client * client, unsigned char type, bool reliable) const;

   /// Will send a destroy/delete-object packet to all clients.
   void sendDestroyToAll() const;
   /// Create and sends a destroy-object packet to a list of clients.
   void sendDestroy(const std::map<unsigned int, Client *> & clientlist) const;
   void sendDestroy( Client * client ) const;

public:
   /// This must produce a unique id for this class, it will be used on the client side to construct new objects.
   virtual const unsigned int getClassId() const = 0;
   /// Here the data-class should fill in data according to update type `type`.
   virtual void fillUpdatePacket(ServerPacket * packet, unsigned char type) const = 0;
   /// Here the data-class should fill in all data required by the constructor on the client side.
   virtual void fillCreateObjectPacket(ServerPacket * packet) const = 0;
   /// Called when ever we receive a packet for this object from a client.
   virtual void clientPacket(Client * client, unsigned char type, ServerPacket * packet) = 0;
};

#endif

---