Sirikata
|
00001 /* Sirikata 00002 * ServerMessageReceiver.hpp 00003 * 00004 * Copyright (c) 2010, Ewen Cheslack-Postava 00005 * All rights reserved. 00006 * 00007 * Redistribution and use in source and binary forms, with or without 00008 * modification, are permitted provided that the following conditions are 00009 * 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 00014 * the documentation and/or other materials provided with the 00015 * distribution. 00016 * * Neither the name of Sirikata nor the names of its contributors may 00017 * be used to endorse or promote products derived from this software 00018 * without specific prior written permission. 00019 * 00020 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS 00021 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 00022 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 00023 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER 00024 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 00025 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 00026 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 00027 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 00028 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 00029 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 00030 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00031 */ 00032 00033 #ifndef _SIRIKATA_SERVER_MESSAGE_RECEIVER_HPP_ 00034 #define _SIRIKATA_SERVER_MESSAGE_RECEIVER_HPP_ 00035 00036 #include <sirikata/core/util/Platform.hpp> 00037 #include <sirikata/space/SpaceContext.hpp> 00038 #include <sirikata/core/service/TimeProfiler.hpp> 00039 #include <sirikata/space/SpaceNetwork.hpp> 00040 #include <sirikata/space/CoordinateSegmentation.hpp> 00041 #include "RateEstimator.hpp" 00042 00043 namespace Sirikata{ 00044 00045 class SpaceContext; 00046 class Message; 00047 00054 class ServerMessageReceiver : public SpaceNetwork::ReceiveListener, CoordinateSegmentation::Listener { 00055 public: 00056 class Listener { 00057 public: 00058 virtual ~Listener() {} 00059 00060 virtual void serverConnectionReceived(ServerID sid) = 0; 00061 00062 virtual void serverMessageReceived(Message* msg) = 0; 00063 }; 00064 00065 ServerMessageReceiver(SpaceContext* ctx, SpaceNetwork* net, Listener* listener); 00066 virtual ~ServerMessageReceiver(); 00067 00068 // Invoked by Forwarder when it needs to update the weight for a given 00069 // server. Implementations shouldn't override, instead they should 00070 // implement the protected handleUpdateSenderStats which will occur on 00071 // receiver strand. 00072 void updateSenderStats(ServerID sid, double total_weight, double used_weight); 00073 00074 // Get the total weight (real total, not just used) feeding into this queue. 00075 double totalUsedWeight(); 00076 // Get the capacity of this receiver in bytes per second. 00077 double capacity(); 00078 bool isBlocked() const{ 00079 return mBlocked; 00080 } 00081 protected: 00082 // SpaceNetwork::ReceiveListener Interface 00083 virtual void networkReceivedConnection(SpaceNetwork::ReceiveStream* strm) = 0; 00084 virtual void networkReceivedData(SpaceNetwork::ReceiveStream* strm) = 0; 00085 // CoordinateSegmentation::Listener Interface 00086 virtual void updatedSegmentation(CoordinateSegmentation* cseg, const std::vector<SegmentationInfo>& new_segmentation); 00087 // ServerMessageReceiver Protected (Implementation) Interface 00088 virtual void handleUpdateSenderStats(ServerID sid, double total_weight, double used_weight) = 0; 00089 00090 SpaceContext* mContext; 00091 Network::IOStrand* mReceiverStrand; 00092 SpaceNetwork* mNetwork; 00093 TimeProfiler::Stage* mProfiler; 00094 Listener* mListener; 00095 00096 // Total weights are handled by the main strand since that's the only place 00097 // they are needed. Handling of used weights is implementation dependent and 00098 // goes to the receiver strand. 00099 typedef std::tr1::unordered_map<ServerID, double> WeightMap; 00100 WeightMap mUsedWeights; 00101 double mUsedWeightSum; 00102 00103 bool mBlocked; 00104 SimpleRateEstimator mCapacityEstimator; 00105 double mCapacityOverestimate; 00106 }; 00107 00108 } // namespace Sirikata 00109 00110 #endif //_SIRIKATA_SERVER_MESSAGE_RECEIVER_HPP_