srv-players.h

Go to the documentation of this file.

/*
 * srv-players.h
 *
 * Copyright (C) 2009  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Server-side player management.  Player == playing instance of a user
 */

#ifndef AESOP_SRV_PLAYERS_H__
#define AESOP_SRV_PLAYERS_H__

// includes --------------------------------------------------------------------
#include "srv-users.h"

#include "aesop-physics/aesop-physics.h"


namespace aesop {





typedef dword_t conn_id_t;


enum ePrivilege {
        ePrivilege_Admin        = 0x0001,       

        // keep this last
        ePrivilege_Invalid      = 0x8000
};


struct player_rec_t {
        // constructor, manipulators, helpers
        player_rec_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                        udpConnId = 0;
                        playerId = 0;
                        flags = 0;
                        username.clear();
                        playerTag.clear();
                        mapId.clear();
                        startId.clear();
                        obj = NULL;
                }
        bool isAuthenticated(void) const throw()
                { return !username.isEmpty() && !playerTag.isEmpty(); }
        bool isInMap(void) const throw()
                { return !mapId.isEmpty() && obj; }
        bool isTargetingMap(void) const throw()
                { return !obj && !mapId.isEmpty() && !startId.isEmpty(); }
        void targetMap(IN const char * inMap, IN const char * inStart) {
                        ASSERT(inMap, "null");
                        ASSERT(inStart, "null");
                        obj = NULL;
                        mapId.set(inMap);
                        startId.set(inStart);
                }
        ePlayerMode getMode(void) const throw() {
                        if (username.isEmpty() || playerTag.isEmpty())
                                return ePlayerMode_UnAuth;
                        if (mapId.isEmpty() || startId.isEmpty())
                                return ePlayerMode_Browse;
                        return ePlayerMode_Game;
                }

        // raw data fields
        conn_id_t               udpConnId;
        int                     playerId; 
        int                     flags;  
        AESOPTagBuffer          username;
        AESOPTagBuffer          playerTag;
        AESOPIdBuffer           mapId;
        AESOPIdBuffer           startId;
        smart_ptr<PhysicsObject> obj;   
};



class PlayerManager {
public:
        // helper classes ------------------------------------------------------
        struct iterator_t {
        private:
                byte_t          opaque[8 * sizeof(long)];
        };

        // virtual destructor --------------------------------------------------
        virtual ~PlayerManager(void) throw();

        // aesop::PlayerManager class interface methods -----------------------
        virtual void updatePlayer(IN player_rec_t& pr) = 0;
        virtual bool getPlayerByHostAndPlayerId(IN conn_id_t udpConnId,
                                IN int playerId,
                                OUT player_rec_t& pr) = 0;

        virtual void getIterator(IN conn_id_t udpConnId,
                                OUT iterator_t& iterator) = 0;

        virtual bool getNextPlayer(IO iterator_t& iterator,
                                OUT player_rec_t& pr) = 0;

        // static factory methods ----------------------------------------------
        static smart_ptr<PlayerManager> create(
                                IN smart_ptr<UserManager>& userMgr);
};



};      // aesop namespace

#endif  // AESOP_SRV_PLAYERS_H__