include/libtorrent/connection_queue.hpp

   1 /*
   2
   3 Copyright (c) 2007, Arvid Norberg
   4 All rights reserved.
   5
   6 Redistribution and use in source and binary forms, with or without
   7 modification, are permitted provided that the following conditions
   8 are met:
   9
  10     * Redistributions of source code must retain the above copyright
  11       notice, this list of conditions and the following disclaimer.
  12     * Redistributions in binary form must reproduce the above copyright
  13       notice, this list of conditions and the following disclaimer in
  14       the documentation and/or other materials provided with the distribution.
  15     * Neither the name of the author nor the names of its
  16       contributors may be used to endorse or promote products derived
  17       from this software without specific prior written permission.
  18
  19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  23 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29 POSSIBILITY OF SUCH DAMAGE.
  30
  31 */
  32
  33 #ifndef TORRENT_CONNECTION_QUEUE
  34 #define TORRENT_CONNECTION_QUEUE
  35
  36 #include <list>
  37 #include <boost/function.hpp>
  38 #include <boost/noncopyable.hpp>
  39 #include <boost/thread/recursive_mutex.hpp>
  40 #include "libtorrent/socket.hpp"
  41 #include "libtorrent/time.hpp"
  42
  43 #ifdef TORRENT_CONNECTION_LOGGING
  44 #include <fstream>
  45 #endif
  46
  47 namespace libtorrent
  48 {
  49
  50 class connection_queue : public boost::noncopyable
  51 {
  52 public:
  53         connection_queue(io_service& ios);
  54
  55         // if there are no free slots, returns the negative
  56         // number of queued up connections
  57         int free_slots() const;
  58
  59         void enqueue(boost::function<void(int)> const& on_connect
  60                 , boost::function<void()> const& on_timeout
  61                 , time_duration timeout, int priority = 0);
  62         void done(int ticket);
  63         void limit(int limit);
  64         int limit() const;
  65         void close();
  66
  67 #ifndef NDEBUG
  68         void check_invariant() const;
  69 #endif
  70
  71 private:
  72
  73         void try_connect();
  74         void on_timeout(error_code const& e);
  75
  76         struct entry
  77         {
  78                 entry(): connecting(false), ticket(0), expires(max_time()), priority(0) {}
  79                 // called when the connection is initiated
  80                 boost::function<void(int)> on_connect;
  81                 // called if done hasn't been called within the timeout
  82                 boost::function<void()> on_timeout;
  83                 bool connecting;
  84                 int ticket;
  85                 ptime expires;
  86                 time_duration timeout;
  87                 int priority;
  88         };
  89
  90         std::list<entry> m_queue;
  91
  92         // the next ticket id a connection will be given
  93         int m_next_ticket;
  94         int m_num_connecting;
  95         int m_half_open_limit;
  96
  97         deadline_timer m_timer;
  98
  99         typedef boost::recursive_mutex mutex_t;
 100         mutable mutex_t m_mutex;
 101
 102 #ifndef NDEBUG
 103         bool m_in_timeout_function;
 104 #endif
 105 #ifdef TORRENT_CONNECTION_LOGGING
 106         std::ofstream m_log;
 107 #endif
 108 };
 109
 110 }
 111
 112 #endif
 113