netwerk/base/ThrottleQueue.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_net_ThrottleQueue_h
   8 #define mozilla_net_ThrottleQueue_h
   9
  10 #include "mozilla/TimeStamp.h"
  11 #include "nsINamed.h"
  12 #include "nsIThrottledInputChannel.h"
  13 #include "nsITimer.h"
  14
  15 namespace mozilla {
  16 namespace net {
  17
  18 class ThrottleInputStream;
  19
  20 /**
  21  * An implementation of nsIInputChannelThrottleQueue that can be used
  22  * to throttle uploads.  This class is not thread-safe.
  23  * Initialization and calls to WrapStream may be done on any thread;
  24  * but otherwise, after creation, it can only be used on the socket
  25  * thread.  It currently throttles with a one second granularity, so
  26  * may be a bit choppy.
  27  */
  28
  29 class ThrottleQueue final : public nsIInputChannelThrottleQueue,
  30                             public nsITimerCallback,
  31                             public nsINamed {
  32  public:
  33   ThrottleQueue();
  34
  35   NS_DECL_THREADSAFE_ISUPPORTS
  36   NS_DECL_NSIINPUTCHANNELTHROTTLEQUEUE
  37   NS_DECL_NSITIMERCALLBACK
  38   NS_DECL_NSINAMED
  39
  40   void QueueStream(ThrottleInputStream* aStream);
  41   void DequeueStream(ThrottleInputStream* aStream);
  42
  43  private:
  44   ~ThrottleQueue();
  45
  46   struct ThrottleEntry {
  47     TimeStamp mTime;
  48     uint32_t mBytesRead;
  49   };
  50
  51   nsTArray<ThrottleEntry> mReadEvents;
  52   uint32_t mMeanBytesPerSecond;
  53   uint32_t mMaxBytesPerSecond;
  54   uint64_t mBytesProcessed;
  55
  56   nsTArray<RefPtr<ThrottleInputStream>> mAsyncEvents;
  57   nsCOMPtr<nsITimer> mTimer;
  58   bool mTimerArmed;
  59 };
  60
  61 }  // namespace net
  62 }  // namespace mozilla
  63
  64 #endif  //  mozilla_net_ThrottleQueue_h