JoinRoomRequest.h

// ===================================================================
//
// Description      
//      Contains the definition of JoinRoomRequest
//
// Revision history
//      Date            Description
//      30-Nov-2012     First version
//
// ===================================================================
#ifndef __JoinRoomRequest__
#define __JoinRoomRequest__

#include "../Util/Common.h"
#include "BaseRequest.h"

#include <boost/shared_ptr.hpp>         // Boost Asio shared pointer

#if defined(_MSC_VER)
#pragma warning(disable:4786)           // STL library: disable warning 4786; this warning is generated due to a Microsoft bug
#endif
#include <list>                         // STL library: list object
#include <string>                       // STL library: string object
using namespace std;                    // STL library: declare the STL namespace

namespace Sfs2X {
namespace Requests {

    class DLLImportExport JoinRoomRequest : public BaseRequest
    {
    public:

        // -------------------------------------------------------------------
        // Public methods
        // -------------------------------------------------------------------

        JoinRoomRequest(boost::shared_ptr<Room> id, string pass, boost::shared_ptr<long int> roomIdToLeave, bool asSpectator);
        JoinRoomRequest(string id, string pass, boost::shared_ptr<long int> roomIdToLeave, bool asSpectator);
        JoinRoomRequest(long int id, string pass, boost::shared_ptr<long int> roomIdToLeave, bool asSpectator);

        JoinRoomRequest(boost::shared_ptr<Room> id, string pass, boost::shared_ptr<long int> roomIdToLeave);
        JoinRoomRequest(string id, string pass, boost::shared_ptr<long int> roomIdToLeave);
        JoinRoomRequest(long int id, string pass, boost::shared_ptr<long int> roomIdToLeave);

        JoinRoomRequest(boost::shared_ptr<Room> id, string pass);
        JoinRoomRequest(string id, string pass);
        JoinRoomRequest(long int id, string pass);

        JoinRoomRequest(boost::shared_ptr<Room> id);
        JoinRoomRequest(string id);
        JoinRoomRequest(long int id);

        virtual ~JoinRoomRequest();

        void Validate(boost::shared_ptr<SmartFox> sfs);

        void Execute (boost::shared_ptr<SmartFox> sfs);

        // -------------------------------------------------------------------
        // Public members
        // -------------------------------------------------------------------
        static boost::shared_ptr<string> KEY_ROOM;
        
        static boost::shared_ptr<string> KEY_USER_LIST;
        
        static boost::shared_ptr<string> KEY_ROOM_NAME;
        
        static boost::shared_ptr<string> KEY_ROOM_ID;
        
        static boost::shared_ptr<string> KEY_PASS;
        
        static boost::shared_ptr<string> KEY_ROOM_TO_LEAVE;
        
        static boost::shared_ptr<string> KEY_AS_SPECTATOR;

    protected:

        // -------------------------------------------------------------------
        // Protected methods
        // -------------------------------------------------------------------

        // -------------------------------------------------------------------
        // Protected members
        // -------------------------------------------------------------------

    private:

        // -------------------------------------------------------------------
        // Private methods
        // -------------------------------------------------------------------
        void Init(boost::shared_ptr<Room> id, boost::shared_ptr<string> pass, boost::shared_ptr<long int> roomIdToLeave, bool asSpectator);
        void Init(string id, boost::shared_ptr<string> pass, boost::shared_ptr<long int> roomIdToLeave, bool asSpectator);
        void Init(long int id, boost::shared_ptr<string> pass, boost::shared_ptr<long int> roomIdToLeave, bool asSpectator);

        // -------------------------------------------------------------------
        // Private members
        // -------------------------------------------------------------------
        long int id;
        boost::shared_ptr<string> name;
        boost::shared_ptr<string> pass;
        boost::shared_ptr<long int> roomIdToLeave;
        bool asSpectator;
    };

}   // namespace Requests
}   // namespace Sfs2X

#endif