GeneralCongestionManager.hxx

Go to the documentation of this file.

#ifndef GENERAL_CONGESTION_MANAGER_HXX
#define GENERAL_CONGESTION_MANAGER_HXX
 
#include "rutil/CongestionManager.hxx"
#include "rutil/Mutex.hxx"
 
#include <vector>
 
namespace resip
{
class GeneralCongestionManager : public CongestionManager
{
   public:
      typedef enum
      {
         SIZE=0, 
         TIME_DEPTH, 
         WAIT_TIME 
      } MetricType;
 
      GeneralCongestionManager(MetricType defaultMetric,
                                 uint32_t defaultMaxTolerance);
      virtual ~GeneralCongestionManager();
 
      virtual bool updateFifoTolerances(const resip::Data& fifoDescription,
                                          MetricType metric,
                                          uint32_t maxTolerance );
 
      virtual void registerFifo(resip::FifoStatsInterface* fifo,
                                 MetricType metric,
                                 uint32_t maxTolerance );
 
      virtual void registerFifo(resip::FifoStatsInterface* fifo)
      {
         registerFifo(fifo, mDefaultMetric, mDefaultMaxTolerance);
      }
 
      virtual void unregisterFifo(resip::FifoStatsInterface* fifo);
 
      virtual RejectionBehavior getRejectionBehavior(const FifoStatsInterface *fifo) const;
 
      virtual uint16_t getCongestionPercent(const FifoStatsInterface* fifo) const;
 
      virtual void logCurrentState() const;
      virtual EncodeStream& encodeCurrentState(EncodeStream& strm) const;
 
   private:
      virtual RejectionBehavior getRejectionBehaviorInternal(const FifoStatsInterface *fifo) const;
      uint16_t getCongestionPercentInternal(const FifoStatsInterface* fifo) const;
 
      virtual EncodeStream& encodeFifoStats(const FifoStatsInterface& fifoStats, EncodeStream& strm) const;
 
      typedef struct
      {
         FifoStatsInterface* fifo;
         volatile MetricType metric;
         volatile uint32_t maxTolerance;
      } FifoInfo; // !bwc! TODO pick a better name
 
      std::vector<FifoInfo> mFifos;
      // !slg! would love to get rid of the following mutex - but we need to protect  
      //       threads querying the congestion stats and make sure runtime transport 
      //       additions are safe (ie: registerFifo and unregisterFifo being called 
      //       when the fifos are in full motion.
      mutable Mutex mFifosMutex;
      uint16_t mRejectionThresholds[REJECTING_NON_ESSENTIAL+1];
      MetricType mDefaultMetric;
      uint32_t mDefaultMaxTolerance;
 
      // disabled
      GeneralCongestionManager();
      GeneralCongestionManager(const GeneralCongestionManager& orig);
      GeneralCongestionManager& operator=(const GeneralCongestionManager& rhs);
};
}
 
#endif
 
/* ====================================================================
 * The Vovida Software License, Version 1.0 
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 
 * 2. 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.
 * 
 * 3. The names "VOCAL", "Vovida Open Communication Application Library",
 *    and "Vovida Open Communication Application Library (VOCAL)" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact vocal@vovida.org.
 *
 * 4. Products derived from this software may not be called "VOCAL", nor
 *    may "VOCAL" appear in their name, without prior written
 *    permission of Vovida Networks, Inc.
 * 
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
 * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL VOVIDA
 * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
 * IN EXCESS OF $1,000, NOR FOR ANY 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.
 * 
 * ====================================================================
 * 
 * This software consists of voluntary contributions made by Vovida
 * Networks, Inc. and many individuals on behalf of Vovida Networks,
 * Inc.  For more information on Vovida Networks, Inc., please see
 * <http://www.vovida.org/>.
 *
 */