clientdata.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 CLIENTDATA_H
#define CLIENTDATA_H


#include "../common/frameworkdata.h"
#include "clientpacket.h"
#include "clientframework.h"

#include <ptypes.h>

/// @example testclient/testclientsnakebite.h
/**
 * @ingroup Client
 * @brief This interface must be implemented by data on the client.
 * It is very important that the constructor of the subclass calls the constructor of ClientData before reading from the framework packet. This ensures that reading of data is not mixed.
 *
 * @author Lars Langer and Emanuel Greisen
 */
class ClientData : public FrameworkData
{
protected:
   ClientFramework * client_framework;

public:
   ClientData(ClientFramework *f, ClientPacket *p);
   virtual ~ClientData();

protected:
   void enqueuePacket(ClientPacket * packet) const;

public:
   /// This method will be called when ever we receive an update packet from the server.
   virtual void updatePacket(ClientFramework * f, unsigned char updatetype, ClientPacket * packet) = 0;
   /// This method just returns the framework-pointer.
   inline ClientFramework * getFramework() const { return client_framework; };

};

template<class T>
T * ClientPacket::readObject( ClientFramework * f )
{
   // this can be a null-thingy !!!
   unsigned int id = readUInt32();
   if(id)
   {
      // Construct a new object
      T * obj = new T(f, this);

      // Test that T is a subclass of ClientData
      // (a clever compiler will optimize this block out)
      if(false) ClientData * dummyptr = obj;

      return obj;
   }
   return NULL;
}

template<class T>
void ClientPacket::readPtr( ClientData * receiver, T ** ptrptr, ClientFramework * framework )
{
   unsigned int objid = readUInt32();
   if(framework->unregisterPointer(receiver->getFrameworkId(), objid, (ClientData **)ptrptr))
   {

      // Null pointers are represented with 0 as ID (hence we just write null in the pointer and we don't need to register anything)
      if(objid == 0)
      {
         *ptrptr = NULL;
         return;
      }

      // Do a lookup in framework
      ClientData * ptr = framework->getDataObject(objid);
      //This will also make sure that T is a subclass of ClientData
      *ptrptr = static_cast<T *>(ptr);

      // Set this as pending in framework
      // This C-like cast is safe because of the previous static_cast
      framework->registerPointer(receiver->getFrameworkId(), objid, (ClientData **)ptrptr);
   }
}


#endif

---