aesop-srv.h

Go to the documentation of this file.
00001 /*
00002  * aesop-srv.h
00003  *
00004  * Copyright (C) 2007-2009  Thomas A. Vaughan
00005  * All rights reserved.
00006  *
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions are met:
00010  *     * Redistributions of source code must retain the above copyright
00011  *       notice, this list of conditions and the following disclaimer.
00012  *     * Redistributions in binary form must reproduce the above copyright
00013  *       notice, this list of conditions and the following disclaimer in the
00014  *       documentation and/or other materials provided with the distribution.
00015  *     * Neither the name of the <organization> nor the
00016  *       names of its contributors may be used to endorse or promote products
00017  *       derived from this software without specific prior written permission.
00018  *
00019  * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
00020  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00021  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00022  * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
00023  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00024  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00025  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00026  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00027  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00028  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00029  *
00030  *
00031  * Root header for the aesop server.  This is the core (game-independent) server
00032  * code that powers multiplayer online aesops.
00033  */
00034 
00035 #ifndef AESOP_SRV_H__
00036 #define AESOP_SRV_H__
00037 
00038 // includes --------------------------------------------------------------------
00039 #include "srv-game-logic.h"
00040 
00041 
00042 // forward declarations
00043 class Datahash;
00044 
00045 
00046 namespace aesop {
00047 
00048 
00049 ////////////////////////////////////////////////////////////////////////////////
00050 ///
00051 /// \ingroup aesop_core
00052 /// \defgroup aesop_srv AESOP Server Library
00053 ///
00054 /// \n
00055 /// This is the reference implmentation of a aesop server.
00056 ///
00057 ////////////////////////////////////////////////////////////////////////////////
00058 /*@{*/
00059 
00060 
00061 /// Root object that manages all aesop server state.  Typical usage is to
00062 /// construct a rich Datahash containing configuration loaded from files,
00063 /// supply your own GameLogic object containing the game rules,
00064 /// create a Server, and then call exec().
00065 class Server {
00066 public:
00067         // virtual destructor --------------------------------------------------
00068         virtual ~Server(void) throw();
00069 
00070 
00071         // aesop::Server class interface methods ------------------------------
00072 
00073         /// Entry point for the server.  Returns on server exit.  The return
00074         /// value is what the calling program should return.  Zero indicates no
00075         /// errors.
00076         virtual int exec(void) = 0;
00077 
00078         /// Threadsafe method called to request that the server halt (force
00079         /// exec() to return).  Typically called from signal handlers \e etc. 
00080         /// The caller provides the return value to return from exec().
00081         virtual void requestStopTS(IN int retval) = 0;
00082 
00083 
00084         // public static methods (factories) -----------------------------------
00085         static smart_ptr<Server> create(IN smart_ptr<Datahash>& op_params,
00086                                         IN smart_ptr<ServerGameLogic>& gLogic);
00087 };
00088 
00089 
00090 
00091 };      // aesop namespace
00092 
00093 #endif  // AESOP_SRV_H__
00094