aesop-client.h

Go to the documentation of this file.

/*
 * aesop-client.h
 *
 * Copyright (C) 2008,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.
 *
 * Basic client objects for the aesop client/server framework.
 */

#ifndef AESOP_AESOP_CLIENT_H__
#define AESOP_AESOP_CLIENT_H__

// includes --------------------------------------------------------------------
#include "aesop-map/map.h"
#include "aesop-physics/aesop-physics.h"
#include "conversation/conversation.h"
#include "crypto/crypto.h"
#include "dialog/dialog.h"
#include "netlib/netlib.h"
#include "story/story.h"
#include "threadsafe/threadsafe_map.h"
#include "xdrbuf/xdrbuf.h"


// forward declarations
class Datahash;
namespace aesop {
        class MapDynamics;
};


namespace aesop {



enum eClientState {
        eClientState_Searching  = 1, 
        eClientState_Connecting = 2, 
        eClientState_Connected  = 3, 

        // keep this last!
        eClientState_Invalid    = 0
};



class ClientHost {
public:
        // aesop::ClientHost class interface methods ---------------------------
        virtual void notifyKey(IN smart_ptr<crypto::DESKey>& desKey) = 0;

        virtual void requestDialog(IN const char * guid,
                                IN int playerId,
                                IN const Datahash * dialog,
                                IN dialog::Host * host) = 0;

        virtual void destroyDialog(IN const char * guid,
                                IN int playerId) = 0;

        virtual void notifyPlayerMap(IN int playerId,
                                IN smart_ptr<MapDynamics>& dyn) = 0;

        virtual void appendGameData(IN xdrbuf::Output * outbuf) = 0;

        virtual void updateAnimation(IN smart_ptr<PhysicsObject>& obj,
                                IN const char * animationState) = 0;

protected:
        // virtual destructor --------------------------------------------------
        virtual ~ClientHost(void) throw();
};



struct server_info_t {
        // constructor, manipulators
        server_info_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                        publicName = "";
                        address.clear();
                }
        bool isValid(void) const throw() {
                        return address.isValid();
                }

        // data fields
        std::string             publicName;
        netlib::address_t       address;
};



typedef threadsafe_map<std::string, server_info_t> server_map_t;



class Client { 
public:
        // virtual destructor --------------------------------------------------
        virtual ~Client(void) throw();

        // aesop::Client class interface methods -------------------------------

        virtual story::Story * getStory(void) throw() = 0;

        virtual eClientState getState(void) throw() = 0;

        virtual bool getServer(OUT server_info_t& server) = 0;

        virtual const server_map_t& getDiscoveredServers(void) = 0;

        virtual bool requestConnect(IN const char * serverKey) = 0;

        virtual float tick(void) = 0;

        virtual bool createPlayer(IN int playerId) = 0;

        virtual void startLocalConversation(IN const char * guid,
                                IN int playerId,
                                IN smart_ptr<converse::ConversationHost> host) = 0;

        virtual bool isConversationUnderway(IN const char * guid) = 0;

        virtual void newGame(IN int playerId) = 0;

        virtual void requestMove(IN int playerId,
                                IN const point3d_t& delta,
                                IN const point3d_t& euler, 
                                OUT point3d_t& newPosition) = 0;

        virtual bool getPlacement(IN int playerId,
                                OUT placement_t& placement) = 0;

        virtual smart_ptr<PhysicsObject> getPlayerObject(IN int playerId) = 0;

        // public static methods (factories) -----------------------------------
        static smart_ptr<Client> create(IN ClientHost * host,
                                IN smart_ptr<story::Story>& story,
                                IN smart_ptr<Datahash>& op_params);
};



};      // aesop namespace

#endif  // AESOP_AESOP_CLIENT_H__