space/src/OSegLookupQueue.hpp

Go to the documentation of this file.

/*  Sirikata
 *  OSegLookupQueue.hpp
 *
 *  Copyright (c) 2009, Ewen Cheslack-Postava
 *  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 Sirikata 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 THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT OWNER
 * OR CONTRIBUTORS 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.
 */

#ifndef _OSEG_LOOKUP_QUEUE_HPP_
#define _OSEG_LOOKUP_QUEUE_HPP_

#include <sirikata/core/util/Platform.hpp>
#include <sirikata/space/ServerMessage.hpp>
#include <sirikata/space/ObjectSegmentation.hpp>

namespace Sirikata {

class OSegLookupQueue : public OSegLookupListener {
public:
    enum ResolvedFrom {
        ResolvedFromCache,
        ResolvedFromServer
    };

    typedef std::tr1::function<void(Sirikata::Protocol::Object::ObjectMessage*, const OSegEntry&, ResolvedFrom)> LookupCallback;

private:
    struct OSegLookup {
        Sirikata::Protocol::Object::ObjectMessage* msg;
        LookupCallback cb;
        uint32 size;
    };

    class OSegLookupList : protected std::vector<OSegLookup> {
        typedef std::vector<OSegLookup> OSegLookupVector;
        size_t mTotalSize;
    public:
        size_t ByteSize() const;
        size_t size() const;
        OSegLookup& operator[] (size_t where);
        void push_back(const OSegLookup& lu);
        OSegLookupVector::iterator begin();
        OSegLookupVector::iterator end();
    };

    typedef std::tr1::unordered_map<UUID, OSegLookupList, UUID::Hasher> LookupMap;


    Network::IOStrand* mNetworkStrand;
    ObjectSegmentation* mOSeg; // The OSeg that does the heavy lifting

    LookupMap mLookups; // Map of object id being queried -> msgs destined for that object
    int32 mTotalSize; // Total # bytes associated with outstanding lookups
    uint32 mMaxLookups; // Total number of unique OSeg lookups (i.e. number of
                        // UUIDs, not number of requests).

    /* OSegLookupListener Interface */
    virtual void osegLookupCompleted(const UUID& id, const OSegEntry& dest);
    /* Main thread handler for lookups. */
    void handleLookupCompleted(const UUID& id, const OSegEntry& dest);
public:
    OSegLookupQueue(Network::IOStrand* net_strand, ObjectSegmentation* oseg);

    virtual ~OSegLookupQueue() {}

    OSegEntry cacheLookup(const UUID& destid) const;
    bool lookup(Sirikata::Protocol::Object::ObjectMessage* msg, const LookupCallback& cb);
};

} // namespace Sirikata

#endif //_OSEG_LOOKUP_QUEUE_HPP_