srv-converse.h

Go to the documentation of this file.

/*
 * srv-converse.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.
 *
 *
 * Root header for the aesop server.  This is the core (game-independent) server
 * code that powers multiplayer online aesops.
 */

#ifndef AESOP_SRV_CONVERSE_H__
#define AESOP_SRV_CONVERSE_H__

// includes --------------------------------------------------------------------
#include "conversation/conversation.h"
#include "crypto/crypto.h"


namespace aesop {


// forward declarations
class StateUpdates;
class UserManager;


typedef dword_t conn_id_t;



//
//      data structures used by host creation APIs (below)
//

#define VALID_CHECK(exp, msg) if (!(exp)) { DPRINTF(msg); return false; }


struct new_player_conv_data_t {
        // constructor, manipulators
        new_player_conv_data_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                        connId = 0;
                        playerId = 0;
                        updates = NULL;
                        userMgr = NULL;
                }
        bool isValid(void) const throw() {
                        VALID_CHECK(connId, "invalid connection id");
                        VALID_CHECK(playerId > 0, "Invalid player id");
                        VALID_CHECK(updates, "null");
                        VALID_CHECK(userMgr, "null");
                        return true;
                }

        // data fields
        conn_id_t               connId;
        int                     playerId;
        StateUpdates *          updates;
        UserManager *           userMgr;
};



struct admin_conv_data_t {
        // constructor, manipulators
        admin_conv_data_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                }
        bool isValid(void) const throw() {
                        return true;
                }

        // data fields
};



//
//      Host creation APIs
//

smart_ptr<converse::ConversationHost> createNewPlayerConversationHost(
                                IN smart_ptr<crypto::DESKey>& desKey,
                                IN new_player_conv_data_t& data);


smart_ptr<converse::ConversationHost> createAdminConversationHost(
                                IN admin_conv_data_t& data);



};      // aesop namespace

#endif  // AESOP_SRV_CONVERSE_H__