diff options
Diffstat (limited to 'libktorrent/torrent/peerdownloader.h')
| -rw-r--r-- | libktorrent/torrent/peerdownloader.h | 231 |
1 files changed, 231 insertions, 0 deletions
diff --git a/libktorrent/torrent/peerdownloader.h b/libktorrent/torrent/peerdownloader.h new file mode 100644 index 0000000..4eb37d2 --- /dev/null +++ b/libktorrent/torrent/peerdownloader.h @@ -0,0 +1,231 @@ +/*************************************************************************** + * 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 BTPEERDOWNLOADER_H +#define BTPEERDOWNLOADER_H + +#include <set> +#include <qvaluelist.h> +#include <qobject.h> +#include "globals.h" +#include "request.h" + +namespace bt +{ + class Peer; + class Request; + class Piece; + + typedef std::set<Uint32> AllowedFastSet; + /** + * Request with a timestamp. + */ + struct TimeStampedRequest + { + Request req; + TimeStamp time_stamp; + + TimeStampedRequest(); + + /** + * Constructor, set the request and calculate the timestamp. + * @param r The Request + */ + TimeStampedRequest(const Request & r); + + /** + * Copy constructor, copy the request and the timestamp + * @param r The Request + */ + TimeStampedRequest(const TimeStampedRequest & t); + + /** + * Equality operator, compares requests only. + * @param r The Request + * @return true if equal + */ + bool operator == (const Request & r); + + /** + * Equality operator, compares requests only. + * @param r The Request + * @return true if equal + */ + bool operator == (const TimeStampedRequest & r); + + /** + * Assignment operator. + * @param r The Request to copy + * @return *this + */ + TimeStampedRequest & operator = (const Request & r); + + /** + * Assignment operator. + * @param r The TimeStampedRequest to copy + * @return *this + */ + TimeStampedRequest & operator = (const TimeStampedRequest & r); + }; + + + /** + * @author Joris Guisson + * @brief Class which downloads pieces from a Peer + * + * This class downloads Piece's from a Peer. + */ + class PeerDownloader : public QObject + { + Q_OBJECT + public: + /** + * Constructor, set the Peer + * @param peer The Peer + * @param chunk_size Size of a chunk in bytes + */ + PeerDownloader(Peer* peer,Uint32 chunk_size); + virtual ~PeerDownloader(); + + /// See if we can add a request to the wait_queue + bool canAddRequest() const; + + /// Get the number of active requests + Uint32 getNumRequests() const; + + /// Is the Peer choked. + bool isChoked() const; + + /// Is NULL (is the Peer set) + bool isNull() const {return peer == 0;} + + /** + * See if the Peer has a Chunk + * @param idx The Chunk's index + */ + bool hasChunk(Uint32 idx) const; + + /// See if this PeerDownloader has nearly finished a chunk + bool isNearlyDone() const {return grabbed == 1 && nearly_done;} + + /// Set the nearly done status of the PeerDownloader + void setNearlyDone(bool nd) {nearly_done = nd;} + + /** + * Grab the Peer, indicates how many ChunkDownload's + * are using this PeerDownloader. + * @return The number of times this PeerDownloader was grabbed + */ + int grab(); + + /** + * When a ChunkDownload is ready with this PeerDownloader, + * it will release it, so that others can use it. + */ + void release(); + + /// Get the number of times this PeerDownloader was grabbed. + int getNumGrabbed() const {return grabbed;} + + /// Get the Peer + const Peer* getPeer() const {return peer;} + + /// Get the current download rate + Uint32 getDownloadRate() const; + + /** + * Check for timed out requests. + */ + void checkTimeouts(); + + /// Get the maximum number of chunk downloads + Uint32 getMaxChunkDownloads() const; + + /** + * The peer has been choked, all pending requests are rejected. + * (except for allowed fast ones) + */ + void choked(); + + public slots: + /** + * Send a Request. Note that the DownloadCap + * may not allow this. (In which case it will + * be stored temporarely in the unsent_reqs list) + * @param req The Request + */ + void download(const Request & req); + + /** + * Cancel a Request. + * @param req The Request + */ + void cancel(const Request & req); + + /** + * Cancel all Requests + */ + void cancelAll(); + + /** + * Handles a rejected request. + * @param req + */ + void onRejected(const Request & req); + + private slots: + void piece(const Piece & p); + void peerDestroyed(); + void update(); + + signals: + /** + * Emited when a Piece has been downloaded. + * @param p The Piece + */ + void downloaded(const Piece & p); + + /** + * Emitted when a request takes longer then 60 seconds to download. + * The sender of the request will have to request it again. This does not apply for + * unsent requests. Their timestamps will be updated when they get transmitted. + * @param r The request + */ + void timedout(const Request & r); + + /** + * A request was rejected. + * @param req The Request + */ + void rejected(const Request & req); + + + private: + Peer* peer; + QValueList<TimeStampedRequest> reqs; + QValueList<Request> wait_queue; + Uint32 max_wait_queue_size; + int grabbed; + Uint32 chunk_size; + bool nearly_done; + }; + +} + +#endif |