srv-object.h

Go to the documentation of this file.
00001 /*
00002  * srv-object.h
00003  *
00004  * Copyright (C) 2010  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  * Server-side object management.  Maintains server-specific per-object state.
00031  * Note that "server-specific per-object state" refers to object state managed
00032  * by the AESOP Server object.  For instance, there could be other server-side
00033  * state managed by the physics engine, game logic plug-in, etc.
00034  */
00035 
00036 #ifndef AESOP_SRV_OBJECT_H__
00037 #define AESOP_SRV_OBJECT_H__
00038 
00039 // includes --------------------------------------------------------------------
00040 #include "srv-hosts.h"
00041 
00042 #include "typeinst/typeinst.h"
00043 
00044 
00045 // forward declarations
00046 namespace aesop {
00047 };              // end of forward declarations
00048 
00049 
00050 
00051 namespace aesop {
00052 
00053 
00054 /// \ingroup aesop_srv
00055 /*@{*/
00056 
00057 
00058 /// This class maintains server-specific data for objects.  It is an object
00059 ///     of type aesop::ComponentData, where the component name is "_server".
00060 class ServerObject : public ComponentData {
00061 public:
00062         // virtual destructor --------------------------------------------------
00063         virtual ~ServerObject(void) throw();
00064 
00065         // aesop::ServerObject class interface methods -------------------------
00066         virtual void setAnimationState(IN conn_id_t ownerId,
00067                                         IN const char * state) = 0;
00068         virtual const char * getAnimationState(IN conn_id_t recipient) const = 0;
00069 };
00070 
00071 
00072 /// retrieves the server object (server state) based on the Instance.  This will
00073 ///     create an empty state if no server state has already been created.
00074 smart_ptr<ServerObject> getServerObject(IN smart_ptr<Instance>& instance);
00075 
00076 
00077 
00078 };      // aesop namespace
00079 
00080 #endif  // AESOP_SRV_OBJECT_H__
00081