Cancel.h

Go to the documentation of this file.
00001 /*
00002 
00003 Copyright (C) 2005-2007 by Peter Dimov.
00004 
00005 This file is part of Calitko (http://www.calitko.org).
00006 
00007 Calitko is free software; you can redistribute it and/or modify
00008 it under the terms of the GNU General Public License as published by
00009 the Free Software Foundation; either version 2 of the License, or
00010 (at your option) any later version.
00011 
00012 Calitko is distributed in the hope that it will be useful,
00013 but WITHOUT ANY WARRANTY; without even the implied warranty of
00014 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015 GNU General Public License for more details.
00016 
00017 You should have received a copy of the GNU General Public License
00018 along with Calitko; if not, write to the Free Software
00019 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00020 
00021 */
00022 
00023 #ifndef PROTOCOLS__BIT_TORRENT__PACKETS__CANCEL_H
00024 #define PROTOCOLS__BIT_TORRENT__PACKETS__CANCEL_H
00025 
00026 #include "Imports.h"
00027 #include "PacketBase.h"
00028 
00029 namespace Protocols {
00030 namespace BitTorrent {
00031 namespace Packets {
00032 
00034 
00037 class Cancel: public PacketBase
00038 {
00039 public:
00040     QString name() const;
00041     auto_ptr <DataBase> copy() const;
00042 
00043     Cancel (quint32 pieceIndex = 0, quint32 startOffset = 0, quint32 bytesCount = 0);
00044 
00045     quint32     pieceIndex() const;
00046     void        setPieceIndex (quint32);
00047 
00048     quint32     startOffset() const;
00049     void        setStartOffset (quint32);
00050 
00051     quint32     bytesCount() const;
00052     void        setBytesCount (quint32);
00053 
00054 protected:
00055     // Unhide all overloads from the base class to avoid a compiler warning:
00056     using PacketBase::readPayload;
00057     using PacketBase::writePayload;
00058 
00059     void        readPayload (BinaryReader &);
00060     void        writePayload (BinaryWriter &) const;
00061 
00063 
00066     class Data: public PacketBase::Data
00067     {
00068         Q_SHARED_DATA_COPY (Data);
00069 
00070     public:
00071         quint32     pieceIndex;
00072         quint32     startOffset;
00073         quint32     bytesCount;
00074     };
00075 
00076     Q_DECLARE_SHARED_DATA (Data);
00077 
00078 private:
00079     enum Constants
00080     {
00081         PayloadLength       = 12
00082     };
00083 };
00084 
00086 inline quint32 Cancel::pieceIndex() const
00087 { Q_SD (const Data); return d->pieceIndex; }
00088 
00090 inline void Cancel::setPieceIndex (quint32 pieceIndex)
00091 { Q_SD (Data); invalidatePayload(); d->pieceIndex = pieceIndex; }
00092 
00094 inline quint32 Cancel::startOffset() const
00095 { Q_SD (const Data); return d->startOffset; }
00096 
00098 inline void Cancel::setStartOffset (quint32 startOffset)
00099 { Q_SD (Data); invalidatePayload(); d->startOffset = startOffset; }
00100 
00102 inline quint32 Cancel::bytesCount() const
00103 { Q_SD (const Data); return d->bytesCount; }
00104 
00106 inline void Cancel::setBytesCount (quint32 bytesCount)
00107 { Q_SD (Data); invalidatePayload(); d->bytesCount = bytesCount; }
00108 
00109 } // namespace Packets
00110 } // namespace BitTorrent
00111 } // namespace Protocols
00112 
00113 #endif // PROTOCOLS__BIT_TORRENT__PACKETS__CANCEL_H