aesop-server/lib/srv-game-logic/srv-game-logic.h

Go to the documentation of this file.
00001 /*
00002  * srv-game-logic.h
00003  *
00004  * Copyright (C) 2008,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  * Declaration of the server-side game logic interfaces.
00032  */
00033 
00034 #ifndef AESOP_REF_SRV_GAME_LOGIC_H__
00035 #define AESOP_REF_SRV_GAME_LOGIC_H__
00036 
00037 // includes --------------------------------------------------------------------
00038 #include "aesop-srv/srv-game-logic.h"   // server defines the interface
00039 
00040 
00041 namespace aesop {
00042 
00043 ////////////////////////////////////////////////////////////////////////////////
00044 ///
00045 /// \ingroup aesop_server
00046 /// \defgroup srv_game_logic_impl Server-Side Game Logic Implementation
00047 ///
00048 /// \n
00049 /// Reference implementation of a server-side game logic object.
00050 ///
00051 /// See aesop::ServerGameLogic for the interface definition.
00052 ///
00053 ////////////////////////////////////////////////////////////////////////////////
00054 /*@{*/
00055 
00056 
00057 ////////////////////////////////////////////////////////////////////////////////
00058 //
00059 //      public API
00060 //
00061 ////////////////////////////////////////////////////////////////////////////////
00062 
00063 /// factory method to create a basic server-side game logic object
00064 smart_ptr<ServerGameLogic> createServerGameLogic(void);
00065 
00066 
00067 };      // aesop namespace
00068 
00069 #endif  // AESOP_REF_GAME_LOGIC_H__
00070