src/shrpx_rate_limit.h

   1 /*
   2  * nghttp2 - HTTP/2 C Library
   3  *
   4  * Copyright (c) 2015 Tatsuhiro Tsujikawa
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining
   7  * a copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sublicense, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be
  15  * included in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  18  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  20  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  21  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  22  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  23  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24  */
  25 #ifndef SHRPX_RATE_LIMIT_H
  26 #define SHRPX_RATE_LIMIT_H
  27
  28 #include "shrpx.h"
  29
  30 #include <ev.h>
  31
  32 #include <openssl/ssl.h>
  33
  34 namespace shrpx {
  35
  36 class RateLimit {
  37 public:
  38   // We need |ssl| object to check that it has unread decrypted bytes.
  39   RateLimit(struct ev_loop *loop, ev_io *w, size_t rate, size_t burst,
  40             SSL *ssl = nullptr);
  41   ~RateLimit();
  42   size_t avail() const;
  43   void drain(size_t n);
  44   void regen();
  45   void startw();
  46   void stopw();
  47   // Feeds event if ssl_ object has unread decrypted bytes.  This is
  48   // required since it is buffered in ssl_ object, io event is not
  49   // generated unless new incoming data is received.
  50   void handle_tls_pending_read();
  51
  52 private:
  53   ev_timer t_;
  54   ev_io *w_;
  55   struct ev_loop *loop_;
  56   SSL *ssl_;
  57   size_t rate_;
  58   size_t burst_;
  59   size_t avail_;
  60   bool startw_req_;
  61 };
  62
  63 } // namespace shrpx
  64
  65 #endif // SHRPX_RATE_LIMIT_H