space/src/FairServerMessageReceiver.hpp

Go to the documentation of this file.

/*  Sirikata
 *  FairServerMessageReceiver.hpp
 *
 *  Copyright (c) 2010, 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 _SIRIKATA_FAIR_SERVER_MESSAGE_RECEIVER_HPP_
#define _SIRIKATA_FAIR_SERVER_MESSAGE_RECEIVER_HPP_

#include "ServerMessageReceiver.hpp"
#include <sirikata/core/queue/FairQueue.hpp>
#include "NetworkQueueWrapper.hpp"

namespace Sirikata {

class FairServerMessageReceiver : public ServerMessageReceiver {
public:
    FairServerMessageReceiver(SpaceContext* ctx, SpaceNetwork* net, Listener* listener);
    virtual ~FairServerMessageReceiver();

private:
    // ServerMessageReceiver Protected (Implementation) Interface
    virtual void handleUpdateSenderStats(ServerID sid, double total_weight, double used_weight);

    // SpaceNetwork::ReceiveListener Interface
    virtual void networkReceivedConnection(SpaceNetwork::ReceiveStream* strm);
    virtual void networkReceivedData(SpaceNetwork::ReceiveStream* strm);

    // Internal service call -- generated either by a networkReceivedData event
    // or by a timer as we wait for enough bandwidth to be available to service
    // the next packet.
    void service();

    Network::IOTimerPtr mServiceTimer; // Timer used to generate another service callback
                              // when waiting for enough bytes to service next
                              // packet

    FairQueue<Message, ServerID, NetworkQueueWrapper > mReceiveQueues;

    typedef std::set<ServerID> ReceiveServerSet;
    ReceiveServerSet mReceiveSet;

    // Protects changes to whether the queue is going to be serviced again. This
    // *must* be protected by the mMutex lock since it's tied to whether there
    // are inputs on the queues.
    bool mServicing;

    uint32 mStoppedUnderflow;
    uint32 mStoppedMaxMessages;

    uint32 mBytesUsed;

    // Protects mReceiveQueues, mReceiveSet
    boost::mutex mMutex;
};

} // namespace Sirikata

#endif //_SIRIKATA_FAIR_SERVER_MESSAGE_RECEIVER_HPP_