plugin.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 PLUGIN_H
#define PLUGIN_H

#include <string>
#include <ptypes.h>

#include "../common/packetchainstep.h"

template<class PacketType>
class PreSendingChain;

/**
 * @ingroup Common
 * @brief This interface is for plugins. It is assumed that plugins have both a "pack(p)" and an "unpack(p)".
 * @author Lars Langer and Emanuel Greisen
*/
template<class PacketType>
class Plugin : public PacketChainStep<PacketType>
{
friend class PreSendingChain<PacketType>;

public:
   Plugin();
   virtual ~Plugin();

protected:
   /// This method will send the packet along the chain of plugins when packing.
   void forwardPack(PacketType * packet);
   /// This method will send the packet along the chain of plugins when unpacking.
   void forwardUnpack(PacketType * packet);

public:
   /// This method must return a unique number identifying the plugin.
   virtual const unsigned int getUniqueId() const = 0;
   /// Will be called when ever a packet must be packed, Remember to call forwardPack(packet) with your resulting packet.
   virtual void pack(PacketType * packet) = 0;
   /// Will be called when ever a packet must be unpacked, Remember to call forwardUnpack(packet) with your resulting packet.
   virtual void unpack(PacketType * packet) = 0;
};


template<class PacketType>
Plugin<PacketType>::Plugin() : PacketChainStep<PacketType>()
{
}

template<class PacketType>
Plugin<PacketType>::~Plugin()
{
}

template<class PacketType>
void Plugin<PacketType>::forwardPack( PacketType * packet )
{
   this->getNext()->pack(packet);
}

template<class PacketType>
void Plugin<PacketType>::forwardUnpack( PacketType * packet )
{
   this->getNext()->unpack(packet);
}

#endif

---