srv-object.cpp

Go to the documentation of this file.

/*
 * srv-object.cpp
 *
 * Copyright (C) 2010  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.
 *
 * Helpful routines for managing and communicating physics state back down
 * to the client.  See srv-physics.h
 */

// includes -------------------------------------------------------------------
#include "srv-object.h"         // always include our own header first!



namespace aesop {

// interface destructors
ServerObject::~ServerObject(void) throw() { }


// our component name
static const char * s_cName                     = "_server";


//
//      static helper methods
//


//
//      SrvObj -- class that implements the ServerObject interface
//

class SrvObj : public ServerObject {
public:
        // destructor ----------------------------------------------------------
        ~SrvObj(void) throw() { }

        // aesop::ComponentData class interface methods ------------------------
        void dump(void) const throw();

        // aesop::ServerObject class interface methods -------------------------
        void setAnimationState(IN conn_id_t ownerId,
                                IN const char * state);
        const char * getAnimationState(IN conn_id_t recipient) const;

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

private:
        // constructor ---------------------------------------------------------
        SrvObj(void) throw() { }

        // private helper methods ----------------------------------------------
        void initialize(void);

        // private member data -------------------------------------------------
        std::string             m_animState;
        conn_id_t               m_animOwner;
};



//
//      SrvObj -- aesop::ComponentData class interface methods
//

//
//      SrvObj -- aesop::ServerObject class interface methods
//

void
SrvObj::setAnimationState
(
IN conn_id_t ownerId,
IN const char * state
)
{
        // ASSERT(ownerId) -- can be null
        ASSERT(state, "can be empty but not null");

        m_animOwner = ownerId;
        m_animState = state;
}



const char *
SrvObj::getAnimationState
(
IN conn_id_t recipient
)
const
{
        if (recipient == m_animOwner)
                return NULL;    // owner doesn't get their own state back
        return m_animState.c_str();
}



//
//      SrvObj -- public static methods (factories)
//

smart_ptr<ServerObject>
SrvObj::create
(
void
)
{
        smart_ptr<SrvObj> local = new SrvObj;
        ASSERT(local, "out of memory");

        local->initialize();

        return local;
}



//
//      SrvObj -- private helper methods
//

void
SrvObj::initialize
(
void
)
{
        m_animOwner = 0;
}



//
//      public API
//

smart_ptr<ServerObject>
getServerObject
(
IN smart_ptr<Instance>& instance
)
{
        ASSERT(instance, "null");

        smart_ptr<ComponentData> cd = instance->getComponentData(s_cName);
        if (cd) {
                smart_ptr<ServerObject> so = cd;
                ASSERT_THROW(so, "server component data cannot be upcast?");
                return so;
        }

        // no component data registered yet!
        DPRINTF("Creating server component data on the fly...");
        smart_ptr<ServerObject> so = SrvObj::create();
        ASSERT(so, "null");

        cd = so;
        ASSERT(cd, "failed to downcast?");
        instance->setComponentData(s_cName, cd);
        return so;
}



};      // aesop namespace