summaryrefslogtreecommitdiffstats
path: root/libktorrent/interfaces/peersource.h
diff options
context:
space:
mode:
authortpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2010-01-20 02:37:40 +0000
committertpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2010-01-20 02:37:40 +0000
commit9ad5c7b5e23b4940e7a3ea3ca3a6fb77e6a8fab0 (patch)
treed088b5210e77d9fa91d954d8550e00e372b47378 /libktorrent/interfaces/peersource.h
downloadktorrent-9ad5c7b5e23b4940e7a3ea3ca3a6fb77e6a8fab0.tar.gz
ktorrent-9ad5c7b5e23b4940e7a3ea3ca3a6fb77e6a8fab0.zip
Updated to final KDE3 ktorrent release (2.2.6)
git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/applications/ktorrent@1077377 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'libktorrent/interfaces/peersource.h')
-rw-r--r--libktorrent/interfaces/peersource.h118
1 files changed, 118 insertions, 0 deletions
diff --git a/libktorrent/interfaces/peersource.h b/libktorrent/interfaces/peersource.h
new file mode 100644
index 0000000..9c2b589
--- /dev/null
+++ b/libktorrent/interfaces/peersource.h
@@ -0,0 +1,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