1 /* <!-- copyright */ 2 /* 3 * aria2 - The high speed download utility 4 * 5 * Copyright (C) 2006 Tatsuhiro Tsujikawa 6 * 7 * This program is free software; you can redistribute it and/or modify 8 * it under the terms of the GNU General Public License as published by 9 * the Free Software Foundation; either version 2 of the License, or 10 * (at your option) any later version. 11 * 12 * This program is distributed in the hope that it will be useful, 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * GNU General Public License for more details. 16 * 17 * You should have received a copy of the GNU General Public License 18 * along with this program; if not, write to the Free Software 19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 20 * 21 * In addition, as a special exception, the copyright holders give 22 * permission to link the code of portions of this program with the 23 * OpenSSL library under certain conditions as described in each 24 * individual source file, and distribute linked combinations 25 * including the two. 26 * You must obey the GNU General Public License in all respects 27 * for all of the code used other than OpenSSL. If you modify 28 * file(s) with this exception, you may extend this exception to your 29 * version of the file(s), but you are not obligated to do so. If you 30 * do not wish to do so, delete this exception statement from your 31 * version. If you delete this exception statement from all source 32 * files in the program, then also delete it here. 33 */ 34 /* copyright --> */ 35 #ifndef D_PEER_STORAGE_H 36 #define D_PEER_STORAGE_H 37 38 #include "common.h" 39 40 #include <deque> 41 #include <vector> 42 #include <set> 43 #include <memory> 44 45 #include "TransferStat.h" 46 #include "Command.h" 47 #include "a2functional.h" 48 49 namespace aria2 { 50 51 class Peer; 52 53 typedef std::set<std::shared_ptr<Peer>, RefLess<Peer>> PeerSet; 54 55 class PeerStorage { 56 public: 57 virtual ~PeerStorage() = default; 58 59 /** 60 * Adds new peer to the internal peer list. 61 * If the peer is added successfully, returns true. Otherwise returns false. 62 */ 63 virtual bool addPeer(const std::shared_ptr<Peer>& peer) = 0; 64 65 /** 66 * Adds all peers in peers to internal peer list. 67 */ 68 virtual void addPeer(const std::vector<std::shared_ptr<Peer>>& peers) = 0; 69 70 /** 71 * Adds new peer, and checkout it atomically. 72 */ 73 virtual std::shared_ptr<Peer> 74 addAndCheckoutPeer(const std::shared_ptr<Peer>& peer, cuid_t cuid) = 0; 75 76 /** 77 * Returns the number of peers, including used and unused ones. 78 */ 79 virtual size_t countAllPeer() const = 0; 80 81 /** 82 * Returns internal dropped peer list. 83 */ 84 virtual const std::deque<std::shared_ptr<Peer>>& getDroppedPeers() = 0; 85 86 /** 87 * Returns true if at least one unused peer exists. 88 * Otherwise returns false. 89 */ 90 virtual bool isPeerAvailable() = 0; 91 92 /** 93 * Returns used peer set. 94 */ 95 virtual const PeerSet& getUsedPeers() = 0; 96 97 /** 98 * Returns true if peer with ipaddr should be ignored because, for 99 * example, it sends bad data. 100 */ 101 virtual bool isBadPeer(const std::string& ipaddr) = 0; 102 103 /** 104 * Adds peer with ipaddr in bad peer set. 105 */ 106 virtual void addBadPeer(const std::string& ipaddr) = 0; 107 108 /** 109 * Moves first peer in unused peer list to used peer set and calls 110 * Peer::usedBy(cuid). If there is no peer available, returns 111 * std::shared_ptr<Peer>(). 112 */ 113 virtual std::shared_ptr<Peer> checkoutPeer(cuid_t cuid) = 0; 114 115 /** 116 * Tells PeerStorage object that peer is no longer used in the session. 117 */ 118 virtual void returnPeer(const std::shared_ptr<Peer>& peer) = 0; 119 120 virtual bool chokeRoundIntervalElapsed() = 0; 121 122 virtual void executeChoke() = 0; 123 }; 124 125 } // namespace aria2 126 127 #endif // D_PEER_STORAGE_H 128