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
|
/***************************************************************************
* Copyright (C) 2005 by Joris Guisson *
* joris.guisson@gmail.com *
* *
* 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. *
***************************************************************************/
#ifndef KTPEERSOURCE_H
#define KTPEERSOURCE_H
#include <qobject.h>
#include <qvaluelist.h>
#include <util/constants.h>
namespace bt
{
class WaitJob;
}
namespace kt
{
struct PotentialPeer
{
QString ip;
bt::Uint16 port;
bool local;
PotentialPeer() : port(0),local(false) {}
};
/**
* @author Joris Guisson <joris.guisson@gmail.com>
*
* This class is the base class for all classes who which to provide potential peers
* for torrents. PeerSources should work independently and should emit a signal when they
* have peers ready.
*/
class PeerSource : public QObject
{
Q_OBJECT
public:
PeerSource();
virtual ~PeerSource();
/**
* Take the first PotentialPeer from the list. The item
* is removed from the list.
* @param pp PotentialPeer struct to fill
* @return true If there was one available, false if not
*/
bool takePotentialPeer(PotentialPeer & pp);
/**
* Add a peer to the list of peers.
* @param ip The ip
* @param port The port
* @param local Wether or not the peer is on the local network
*/
void addPeer(const QString & ip,bt::Uint16 port,bool local = false);
public slots:
/**
* Start gathering peers.
*/
virtual void start() = 0;
/**
* Stop gathering peers.
*/
virtual void stop(bt::WaitJob* wjob = 0) = 0;
/**
* The torrent has finished downloading.
* This is optional and should be used by HTTP and UDP tracker sources
* to notify the tracker.
*/
virtual void completed();
/**
* PeerSources wanting to implement a manual update, should implement this.
*/
virtual void manualUpdate();
/**
* The source is about to be destroyed. Subclasses can override this
* to clean up some things.
*/
virtual void aboutToBeDestroyed();
signals:
/**
* This signal should be emitted when a new batch of peers is ready.
* @param ps The PeerSource
*/
void peersReady(kt::PeerSource* ps);
private:
/// List to keep the potential peers in.
QValueList<PotentialPeer> peers;
};
}
#endif
|
