srv-msg-router.h

Go to the documentation of this file.

/*
 * srv-msg-router.h
 *
 * Copyright (C) 2008  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.
 *
 *
 * Message router for the aesop server.  Manages connection/user state to
 * determine what messages are allowed, and provides handlers.
 */

#ifndef AESOP_SRV_MESSAGE_ROUTER_H__
#define AESOP_SRV_MESSAGE_ROUTER_H__

// includes --------------------------------------------------------------------
#include "aesop-proto/message.h"
#include "story/story.h"


namespace aesop {


typedef netlib::conn_id_t conn_id_t;
typedef netlib::envelope_t envelope_t;
typedef netlib::MessageBuffer MessageBuffer;


class StateUpdates {
public:
        // aesop::StateUpdates class interface methods -------------------------
        virtual void newTcpConnectionTS(IN conn_id_t tcp_connId,
                                IN long token) = 0;
        virtual void enqueueMessageTS(IN conn_id_t tcp_connId,
                                IN smart_ptr<MessageBuffer>& msg) = 0;
        virtual void notifyDialogReplyTS(IN conn_id_t tcp_conn_id,
                                IN const char * conversationGuid,
                                IN int dialogId,
                                IN int playerId,
                                IN const Datahash * reply) = 0;
        virtual bool setPlayerUserAccountTS(IN conn_id_t tcp_conn_id,
                                IN int playerId,
                                IN const char * username,
                                IN const char * usertag,
                                OUT std::string& diagnostic) = 0;
        virtual void newGameTS(IN conn_id_t tcp_conn_id,
                                IN int playerId) = 0;
        virtual void requestShutdownTS(void) = 0;

protected:
        virtual ~StateUpdates(void) throw();
};


struct handler_state_t {
        // constructor, manipulators
        handler_state_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                        src_env.clear();
                        payload.clear();
                        story = NULL;           // free our reference
                        updates = NULL;
                }

        // data fields
        envelope_t              src_env;        // source of message
        tcp_payload_t           payload;        // payload
        smart_ptr<story::Story> story;
        StateUpdates *          updates;        // ouch! object lifetime?
};


typedef void (*msg_handler_fn)(IN handler_state_t& state);



class MessageRouter {
public:
        // virtual destructor --------------------------------------------------
        virtual ~MessageRouter(void) throw() = 0;

        // aesop::MessageRouter class interface methods -----------------------
        virtual msg_handler_fn getHandler(IN const tcp_payload_t& payload) = 0;

        // static factory methods ----------------------------------------------
        static smart_ptr<MessageRouter> create(void);
};



};      // aesop namespace

#endif  // AESOP_SRV_MESSAGE_ROUTER_H__