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