<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Qt 4.8: peerwireclient.h Example File (network/torrent/peerwireclient.h)</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<h1 class="title">peerwireclient.h Example File</h1>
<span class="small-subtitle">network/torrent/peerwireclient.h</span>
<!-- $$$network/torrent/peerwireclient.h-description -->
<div class="descr"> <a name="details"></a>
<pre class="cpp"> <span class="comment">/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the examples of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
** * Redistributions of source code must retain the above copyright
** notice, this list of conditions and the following disclaimer.
** * Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in
** the documentation and/or other materials provided with the
** distribution.
** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
** of its contributors may be used to endorse or promote products derived
** from this software without specific prior written permission.
**
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
**
** $QT_END_LICENSE$
**
****************************************************************************/</span>
<span class="preprocessor">#ifndef PEERWIRECLIENT_H</span>
<span class="preprocessor">#define PEERWIRECLIENT_H</span>
<span class="preprocessor">#include <QBitArray></span>
<span class="preprocessor">#include <QList></span>
<span class="preprocessor">#include <QTcpSocket></span>
<span class="keyword">class</span> <span class="type"><a href="qhostaddress.html">QHostAddress</a></span>;
<span class="keyword">class</span> <span class="type"><a href="qtimerevent.html">QTimerEvent</a></span>;
<span class="keyword">class</span> TorrentPeer;
<span class="keyword">struct</span> TorrentBlock
{
<span class="keyword">inline</span> TorrentBlock(<span class="type">int</span> p<span class="operator">,</span> <span class="type">int</span> o<span class="operator">,</span> <span class="type">int</span> l)
: pieceIndex(p)<span class="operator">,</span> offset(o)<span class="operator">,</span> length(l)
{
}
<span class="keyword">inline</span> <span class="type">bool</span> <span class="keyword">operator</span><span class="operator">=</span><span class="operator">=</span>(<span class="keyword">const</span> TorrentBlock <span class="operator">&</span>other) <span class="keyword">const</span>
{
<span class="keyword">return</span> pieceIndex <span class="operator">=</span><span class="operator">=</span> other<span class="operator">.</span>pieceIndex
<span class="operator">&</span><span class="operator">&</span> offset <span class="operator">=</span><span class="operator">=</span> other<span class="operator">.</span>offset
<span class="operator">&</span><span class="operator">&</span> length <span class="operator">=</span><span class="operator">=</span> other<span class="operator">.</span>length;
}
<span class="type">int</span> pieceIndex;
<span class="type">int</span> offset;
<span class="type">int</span> length;
};
<span class="keyword">class</span> PeerWireClient : <span class="keyword">public</span> <span class="type"><a href="qtcpsocket.html">QTcpSocket</a></span>
{
Q_OBJECT
<span class="keyword">public</span>:
<span class="keyword">enum</span> PeerWireStateFlag {
ChokingPeer <span class="operator">=</span> <span class="number">0x1</span><span class="operator">,</span>
InterestedInPeer <span class="operator">=</span> <span class="number">0x2</span><span class="operator">,</span>
ChokedByPeer <span class="operator">=</span> <span class="number">0x4</span><span class="operator">,</span>
PeerIsInterested <span class="operator">=</span> <span class="number">0x8</span>
};
Q_DECLARE_FLAGS(PeerWireState<span class="operator">,</span> PeerWireStateFlag)
PeerWireClient(<span class="keyword">const</span> <span class="type"><a href="qbytearray.html">QByteArray</a></span> <span class="operator">&</span>peerId<span class="operator">,</span> <span class="type"><a href="qobject.html">QObject</a></span> <span class="operator">*</span>parent <span class="operator">=</span> <span class="number">0</span>);
<span class="type">void</span> initialize(<span class="keyword">const</span> <span class="type"><a href="qbytearray.html">QByteArray</a></span> <span class="operator">&</span>infoHash<span class="operator">,</span> <span class="type">int</span> pieceCount);
<span class="type">void</span> setPeer(TorrentPeer <span class="operator">*</span>peer);
TorrentPeer <span class="operator">*</span>peer() <span class="keyword">const</span>;
<span class="comment">// State</span>
<span class="keyword">inline</span> PeerWireState peerWireState() <span class="keyword">const</span> { <span class="keyword">return</span> pwState; }
<span class="type"><a href="qbitarray.html">QBitArray</a></span> availablePieces() <span class="keyword">const</span>;
<span class="type"><a href="qlist.html">QList</a></span><span class="operator"><</span>TorrentBlock<span class="operator">></span> incomingBlocks() <span class="keyword">const</span>;
<span class="comment">// Protocol</span>
<span class="type">void</span> chokePeer();
<span class="type">void</span> unchokePeer();
<span class="type">void</span> sendInterested();
<span class="type">void</span> sendKeepAlive();
<span class="type">void</span> sendNotInterested();
<span class="type">void</span> sendPieceNotification(<span class="type">int</span> piece);
<span class="type">void</span> sendPieceList(<span class="keyword">const</span> <span class="type"><a href="qbitarray.html">QBitArray</a></span> <span class="operator">&</span>bitField);
<span class="type">void</span> requestBlock(<span class="type">int</span> piece<span class="operator">,</span> <span class="type">int</span> offset<span class="operator">,</span> <span class="type">int</span> length);
<span class="type">void</span> cancelRequest(<span class="type">int</span> piece<span class="operator">,</span> <span class="type">int</span> offset<span class="operator">,</span> <span class="type">int</span> length);
<span class="type">void</span> sendBlock(<span class="type">int</span> piece<span class="operator">,</span> <span class="type">int</span> offset<span class="operator">,</span> <span class="keyword">const</span> <span class="type"><a href="qbytearray.html">QByteArray</a></span> <span class="operator">&</span>data);
<span class="comment">// Rate control</span>
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> writeToSocket(<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> bytes);
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> readFromSocket(<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> bytes);
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> downloadSpeed() <span class="keyword">const</span>;
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> uploadSpeed() <span class="keyword">const</span>;
<span class="type">bool</span> canTransferMore() <span class="keyword">const</span>;
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> bytesAvailable() <span class="keyword">const</span> { <span class="keyword">return</span> incomingBuffer<span class="operator">.</span>size() <span class="operator">+</span> <span class="type"><a href="qtcpsocket.html">QTcpSocket</a></span><span class="operator">::</span>bytesAvailable(); }
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> socketBytesAvailable() <span class="keyword">const</span> { <span class="keyword">return</span> socket<span class="operator">.</span>bytesAvailable(); }
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> socketBytesToWrite() <span class="keyword">const</span> { <span class="keyword">return</span> socket<span class="operator">.</span>bytesToWrite(); }
<span class="type">void</span> setReadBufferSize(<span class="type">int</span> size);
<span class="keyword">signals</span>:
<span class="type">void</span> infoHashReceived(<span class="keyword">const</span> <span class="type"><a href="qbytearray.html">QByteArray</a></span> <span class="operator">&</span>infoHash);
<span class="type">void</span> readyToTransfer();
<span class="type">void</span> choked();
<span class="type">void</span> unchoked();
<span class="type">void</span> interested();
<span class="type">void</span> notInterested();
<span class="type">void</span> piecesAvailable(<span class="keyword">const</span> <span class="type"><a href="qbitarray.html">QBitArray</a></span> <span class="operator">&</span>pieces);
<span class="type">void</span> blockRequested(<span class="type">int</span> pieceIndex<span class="operator">,</span> <span class="type">int</span> begin<span class="operator">,</span> <span class="type">int</span> length);
<span class="type">void</span> blockReceived(<span class="type">int</span> pieceIndex<span class="operator">,</span> <span class="type">int</span> begin<span class="operator">,</span> <span class="keyword">const</span> <span class="type"><a href="qbytearray.html">QByteArray</a></span> <span class="operator">&</span>data);
<span class="type">void</span> bytesReceived(<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> size);
<span class="keyword">protected</span> <span class="keyword">slots</span>:
<span class="type">void</span> connectToHostImplementation(<span class="keyword">const</span> <span class="type"><a href="qstring.html">QString</a></span> <span class="operator">&</span>hostName<span class="operator">,</span>
<span class="type"><a href="qtglobal.html#quint16-typedef">quint16</a></span> port<span class="operator">,</span> OpenMode openMode <span class="operator">=</span> ReadWrite);
<span class="type">void</span> diconnectFromHostImplementation();
<span class="keyword">protected</span>:
<span class="type">void</span> timerEvent(<span class="type"><a href="qtimerevent.html">QTimerEvent</a></span> <span class="operator">*</span>event);
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> readData(<span class="type">char</span> <span class="operator">*</span>data<span class="operator">,</span> <span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> maxlen);
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> readLineData(<span class="type">char</span> <span class="operator">*</span>data<span class="operator">,</span> <span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> maxlen);
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> writeData(<span class="keyword">const</span> <span class="type">char</span> <span class="operator">*</span>data<span class="operator">,</span> <span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> len);
<span class="keyword">private</span> <span class="keyword">slots</span>:
<span class="type">void</span> sendHandShake();
<span class="type">void</span> processIncomingData();
<span class="type">void</span> socketStateChanged(<span class="type"><a href="qabstractsocket.html">QAbstractSocket</a></span><span class="operator">::</span>SocketState state);
<span class="keyword">private</span>:
<span class="comment">// Data waiting to be read/written</span>
<span class="type"><a href="qbytearray.html">QByteArray</a></span> incomingBuffer;
<span class="type"><a href="qbytearray.html">QByteArray</a></span> outgoingBuffer;
<span class="keyword">struct</span> BlockInfo {
<span class="type">int</span> pieceIndex;
<span class="type">int</span> offset;
<span class="type">int</span> length;
<span class="type"><a href="qbytearray.html">QByteArray</a></span> block;
};
<span class="type"><a href="qlist.html">QList</a></span><span class="operator"><</span>BlockInfo<span class="operator">></span> pendingBlocks;
<span class="type">int</span> pendingBlockSizes;
<span class="type"><a href="qlist.html">QList</a></span><span class="operator"><</span>TorrentBlock<span class="operator">></span> incoming;
<span class="keyword">enum</span> PacketType {
ChokePacket <span class="operator">=</span> <span class="number">0</span><span class="operator">,</span>
UnchokePacket <span class="operator">=</span> <span class="number">1</span><span class="operator">,</span>
InterestedPacket <span class="operator">=</span> <span class="number">2</span><span class="operator">,</span>
NotInterestedPacket <span class="operator">=</span> <span class="number">3</span><span class="operator">,</span>
HavePacket <span class="operator">=</span> <span class="number">4</span><span class="operator">,</span>
BitFieldPacket <span class="operator">=</span> <span class="number">5</span><span class="operator">,</span>
RequestPacket <span class="operator">=</span> <span class="number">6</span><span class="operator">,</span>
PiecePacket <span class="operator">=</span> <span class="number">7</span><span class="operator">,</span>
CancelPacket <span class="operator">=</span> <span class="number">8</span>
};
<span class="comment">// State</span>
PeerWireState pwState;
<span class="type">bool</span> receivedHandShake;
<span class="type">bool</span> gotPeerId;
<span class="type">bool</span> sentHandShake;
<span class="type">int</span> nextPacketLength;
<span class="comment">// Upload/download speed records</span>
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> uploadSpeedData<span class="operator">[</span><span class="number">8</span><span class="operator">]</span>;
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> downloadSpeedData<span class="operator">[</span><span class="number">8</span><span class="operator">]</span>;
<span class="type">int</span> transferSpeedTimer;
<span class="comment">// Timeout handling</span>
<span class="type">int</span> timeoutTimer;
<span class="type">int</span> pendingRequestTimer;
<span class="type">bool</span> invalidateTimeout;
<span class="type">int</span> keepAliveTimer;
<span class="comment">// Checksum, peer ID and set of available pieces</span>
<span class="type"><a href="qbytearray.html">QByteArray</a></span> infoHash;
<span class="type"><a href="qbytearray.html">QByteArray</a></span> peerIdString;
<span class="type"><a href="qbitarray.html">QBitArray</a></span> peerPieces;
TorrentPeer <span class="operator">*</span>torrentPeer;
<span class="type"><a href="qtcpsocket.html">QTcpSocket</a></span> socket;
};
<a href="qflags.html#Q_DECLARE_OPERATORS_FOR_FLAGS">Q_DECLARE_OPERATORS_FOR_FLAGS</a>(PeerWireClient<span class="operator">::</span>PeerWireState)
<span class="preprocessor">#endif</span></pre>
</div>
<!-- @@@network/torrent/peerwireclient.h -->
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Digia, Qt and their respective logos are trademarks of Digia Plc
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
