<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- fortuneclient.qdoc -->
<title>Fortune Client Example | Qt Network 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qtnetwork-index.html">Qt Network</a></td><td ><a href="examples-network.html">Network Examples</a></td><td >Fortune Client Example</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Fortune Client Example</h1>
<span class="subtitle"></span>
<!-- $$$fortuneclient-description -->
<div class="descr"> <a name="details"></a>
<p>This example uses <a href="qtcpsocket.html">QTcpSocket</a>, and is intended to be run alongside the <a href="qtnetwork-fortuneserver-example.html">Fortune Server</a> example or the <a href="qtnetwork-threadedfortuneserver-example.html">Threaded Fortune Server</a> example.</p>
<p class="centerAlign"><img src="images/fortuneclient-example.png" alt="Screenshot of the Fortune Client example" /></p><p>This example uses a simple <a href="../qtcore/qdatastream.html">QDataStream</a>-based data transfer protocol to request a line of text from a fortune server (from the <a href="qtnetwork-fortuneserver-example.html">Fortune Server</a> example). The client requests a fortune by simply connecting to the server. The server then responds with a <a href="../qtcore/qstring.html">QString</a> which contains the fortune text.</p>
<p><a href="qtcpsocket.html">QTcpSocket</a> supports two general approaches to network programming:</p>
<ul>
<li><i>The asynchronous (non-blocking) approach.</i> Operations are scheduled and performed when control returns to Qt's event loop. When the operation is finished, <a href="qtcpsocket.html">QTcpSocket</a> emits a signal. For example, <a href="qabstractsocket.html#connectToHost">QTcpSocket::connectToHost</a>() returns immediately, and when the connection has been established, <a href="qtcpsocket.html">QTcpSocket</a> emits <a href="qabstractsocket.html#connected">connected()</a>.</li>
<li><i>The synchronous (blocking) approach.</i> In non-GUI and multithreaded applications, you can call the <code>waitFor...()</code> functions (e.g., <a href="qabstractsocket.html#waitForConnected">QTcpSocket::waitForConnected</a>()) to suspend the calling thread until the operation has completed, instead of connecting to signals.</li>
</ul>
<p>In this example, we will demonstrate the asynchronous approach. The <a href="qtnetwork-blockingfortuneclient-example.html">Blocking Fortune Client Example</a> illustrates the synchronous approach.</p>
<p>Our class contains some data and a few private slots:</p>
<pre class="cpp">
<span class="keyword">class</span> Client : <span class="keyword">public</span> <span class="type">QDialog</span>
{
Q_OBJECT
<span class="keyword">public</span>:
<span class="keyword">explicit</span> Client(<span class="type">QWidget</span> <span class="operator">*</span>parent <span class="operator">=</span> Q_NULLPTR);
<span class="keyword">private</span> <span class="keyword">slots</span>:
<span class="type">void</span> requestNewFortune();
<span class="type">void</span> readFortune();
<span class="type">void</span> displayError(<span class="type"><a href="qabstractsocket.html">QAbstractSocket</a></span><span class="operator">::</span>SocketError socketError);
<span class="type">void</span> enableGetFortuneButton();
<span class="type">void</span> sessionOpened();
<span class="keyword">private</span>:
<span class="type">QComboBox</span> <span class="operator">*</span>hostCombo;
<span class="type">QLineEdit</span> <span class="operator">*</span>portLineEdit;
<span class="type">QLabel</span> <span class="operator">*</span>statusLabel;
<span class="type">QPushButton</span> <span class="operator">*</span>getFortuneButton;
<span class="type"><a href="qtcpsocket.html">QTcpSocket</a></span> <span class="operator">*</span>tcpSocket;
<span class="type"><a href="../qtcore/qdatastream.html">QDataStream</a></span> in;
<span class="type"><a href="../qtcore/qstring.html">QString</a></span> currentFortune;
<span class="type"><a href="qnetworksession.html">QNetworkSession</a></span> <span class="operator">*</span>networkSession;
};
</pre>
<p>Other than the widgets that make up the GUI, the data members include a <a href="qtcpsocket.html">QTcpSocket</a> pointer, a <a href="../qtcore/qdatastream.html">QDataStream</a> object that operates on the socket, and a copy of the fortune text currently displayed.</p>
<p>The socket is initialized in the Client constructor. We'll pass the main widget as parent, so that we won't have to worry about deleting the socket:</p>
<pre class="cpp">
Client<span class="operator">::</span>Client(<span class="type">QWidget</span> <span class="operator">*</span>parent)
: <span class="type">QDialog</span>(parent)
<span class="operator">,</span> hostCombo(<span class="keyword">new</span> <span class="type">QComboBox</span>)
<span class="operator">,</span> portLineEdit(<span class="keyword">new</span> <span class="type">QLineEdit</span>)
<span class="operator">,</span> getFortuneButton(<span class="keyword">new</span> <span class="type">QPushButton</span>(tr(<span class="string">"Get Fortune"</span>)))
<span class="operator">,</span> tcpSocket(<span class="keyword">new</span> <span class="type"><a href="qtcpsocket.html">QTcpSocket</a></span>(<span class="keyword">this</span>))
<span class="operator">,</span> networkSession(Q_NULLPTR)
{
setWindowFlags(windowFlags() <span class="operator">&</span> <span class="operator">~</span><span class="type"><a href="../qtcore/qt.html">Qt</a></span><span class="operator">::</span>WindowContextHelpButtonHint);
...
in<span class="operator">.</span>setDevice(tcpSocket);
in<span class="operator">.</span>setVersion(<span class="type"><a href="../qtcore/qdatastream.html">QDataStream</a></span><span class="operator">::</span>Qt_4_0);
</pre>
<p>The protocol is based on <a href="../qtcore/qdatastream.html">QDataStream</a>, so we set the stream device to the newly created socket. We then explicitly set the protocol version of the stream to <a href="../qtcore/qdatastream.html#Version-enum">QDataStream::Qt_4_0</a> to ensure that we're using the same version as the fortune server, no matter which version of Qt the client and server use.</p>
<p>The only <a href="qtcpsocket.html">QTcpSocket</a> signals we need in this example are <a href="../qtcore/qiodevice.html#readyRead">QTcpSocket::readyRead</a>(), signifying that data has been received, and <a href="qabstractsocket.html#error">QTcpSocket::error</a>(), which we will use to catch any connection errors:</p>
<pre class="qml">
...
connect(tcpSocket<span class="operator">,</span> <span class="operator">&</span><span class="type"><a href="../qtcore/qiodevice.html">QIODevice</a></span><span class="operator">::</span>readyRead<span class="operator">,</span> <span class="keyword">this</span><span class="operator">,</span> <span class="operator">&</span>Client<span class="operator">::</span>readFortune);
connect(tcpSocket<span class="operator">,</span> <span class="type">QOverload</span><span class="operator"><</span><span class="type"><a href="qabstractsocket.html">QAbstractSocket</a></span><span class="operator">::</span>SocketError<span class="operator">></span><span class="operator">::</span>of(<span class="operator">&</span><span class="type"><a href="qabstractsocket.html">QAbstractSocket</a></span><span class="operator">::</span>error)<span class="operator">,</span>
...
}
</pre>
<p>Clicking the <b>Get Fortune</b> button will invoke the <code>requestNewFortune()</code> slot:</p>
<pre class="cpp">
<span class="type">void</span> Client<span class="operator">::</span>requestNewFortune()
{
getFortuneButton<span class="operator">-</span><span class="operator">></span>setEnabled(<span class="keyword">false</span>);
tcpSocket<span class="operator">-</span><span class="operator">></span>abort();
tcpSocket<span class="operator">-</span><span class="operator">></span>connectToHost(hostCombo<span class="operator">-</span><span class="operator">></span>currentText()<span class="operator">,</span>
portLineEdit<span class="operator">-</span><span class="operator">></span>text()<span class="operator">.</span>toInt());
}
</pre>
<p>Because we allow the user to click <b>Get Fortune</b> before the previous connection finished closing, we start off by aborting the previous connection by calling <a href="qabstractsocket.html#abort">QTcpSocket::abort</a>(). (On an unconnected socket, this function does nothing.) We then proceed to connecting to the fortune server by calling <a href="qabstractsocket.html#connectToHost">QTcpSocket::connectToHost</a>(), passing the hostname and port from the user interface as arguments.</p>
<p>As a result of calling <a href="qabstractsocket.html#connectToHost">connectToHost()</a>, one of two things can happen:</p>
<ul>
<li><i>The connection is established.</i> In this case, the server will send us a fortune. <a href="qtcpsocket.html">QTcpSocket</a> will emit <a href="../qtcore/qiodevice.html#readyRead">readyRead()</a> every time it receives a block of data.</li>
<li><i>An error occurs.</i> We need to inform the user if the connection failed or was broken. In this case, <a href="qtcpsocket.html">QTcpSocket</a> will emit <a href="qabstractsocket.html#error">error()</a>, and <code>Client::displayError()</code> will be called.</li>
</ul>
<p>Let's go through the <a href="qabstractsocket.html#error">error()</a> case first:</p>
<pre class="cpp">
<span class="type">void</span> Client<span class="operator">::</span>displayError(<span class="type"><a href="qabstractsocket.html">QAbstractSocket</a></span><span class="operator">::</span>SocketError socketError)
{
<span class="keyword">switch</span> (socketError) {
<span class="keyword">case</span> <span class="type"><a href="qabstractsocket.html">QAbstractSocket</a></span><span class="operator">::</span>RemoteHostClosedError:
<span class="keyword">break</span>;
<span class="keyword">case</span> <span class="type"><a href="qabstractsocket.html">QAbstractSocket</a></span><span class="operator">::</span>HostNotFoundError:
<span class="type">QMessageBox</span><span class="operator">::</span>information(<span class="keyword">this</span><span class="operator">,</span> tr(<span class="string">"Fortune Client"</span>)<span class="operator">,</span>
tr(<span class="string">"The host was not found. Please check the "</span>
<span class="string">"host name and port settings."</span>));
<span class="keyword">break</span>;
<span class="keyword">case</span> <span class="type"><a href="qabstractsocket.html">QAbstractSocket</a></span><span class="operator">::</span>ConnectionRefusedError:
<span class="type">QMessageBox</span><span class="operator">::</span>information(<span class="keyword">this</span><span class="operator">,</span> tr(<span class="string">"Fortune Client"</span>)<span class="operator">,</span>
tr(<span class="string">"The connection was refused by the peer. "</span>
<span class="string">"Make sure the fortune server is running, "</span>
<span class="string">"and check that the host name and port "</span>
<span class="string">"settings are correct."</span>));
<span class="keyword">break</span>;
<span class="keyword">default</span>:
<span class="type">QMessageBox</span><span class="operator">::</span>information(<span class="keyword">this</span><span class="operator">,</span> tr(<span class="string">"Fortune Client"</span>)<span class="operator">,</span>
tr(<span class="string">"The following error occurred: %1."</span>)
<span class="operator">.</span>arg(tcpSocket<span class="operator">-</span><span class="operator">></span>errorString()));
}
getFortuneButton<span class="operator">-</span><span class="operator">></span>setEnabled(<span class="keyword">true</span>);
}
</pre>
<p>We pop up all errors in a dialog using QMessageBox::information(). <a href="qabstractsocket.html#SocketError-enum">QTcpSocket::RemoteHostClosedError</a> is silently ignored, because the fortune server protocol ends with the server closing the connection.</p>
<p>Now for the <a href="../qtcore/qiodevice.html#readyRead">readyRead()</a> alternative. This signal is connected to <code>Client::readFortune()</code>:</p>
<pre class="cpp">
<span class="type">void</span> Client<span class="operator">::</span>readFortune()
{
in<span class="operator">.</span>startTransaction();
<span class="type"><a href="../qtcore/qstring.html">QString</a></span> nextFortune;
in <span class="operator">></span><span class="operator">></span> nextFortune;
<span class="keyword">if</span> (<span class="operator">!</span>in<span class="operator">.</span>commitTransaction())
<span class="keyword">return</span>;
<span class="keyword">if</span> (nextFortune <span class="operator">=</span><span class="operator">=</span> currentFortune) {
<span class="type"><a href="../qtcore/qtimer.html">QTimer</a></span><span class="operator">::</span>singleShot(<span class="number">0</span><span class="operator">,</span> <span class="keyword">this</span><span class="operator">,</span> <span class="operator">&</span>Client<span class="operator">::</span>requestNewFortune);
<span class="keyword">return</span>;
}
currentFortune <span class="operator">=</span> nextFortune;
statusLabel<span class="operator">-</span><span class="operator">></span>setText(currentFortune);
getFortuneButton<span class="operator">-</span><span class="operator">></span>setEnabled(<span class="keyword">true</span>);
}
</pre>
<p>Now, TCP is based on sending a stream of data, so we cannot expect to get the entire fortune in one go. Especially on a slow network, the data can be received in several small fragments. <a href="qtcpsocket.html">QTcpSocket</a> buffers up all incoming data and emits <a href="../qtcore/qiodevice.html#readyRead">readyRead()</a> for every new block that arrives, and it is our job to ensure that we have received all the data we need before we start parsing.</p>
<p>For this purpose we use a <a href="../qtcore/qdatastream.html">QDataStream</a> read transaction. It keeps reading stream data into an internal buffer and rolls it back in case of an incomplete read. We start by calling startTransaction() which also resets the stream status to indicate that new data was received on the socket. We proceed by using <a href="../qtcore/qdatastream.html">QDataStream</a>'s streaming operator to read the fortune from the socket into a <a href="../qtcore/qstring.html">QString</a>. Once read, we complete the transaction by calling <a href="../qtcore/qdatastream.html#commitTransaction">QDataStream::commitTransaction</a>(). If we did not receive a full packet, this function restores the stream data to the initial position, after which we can wait for a new readyRead() signal.</p>
<p>After a successful read transaction, we call QLabel::setText() to display the fortune.</p>
<p>Files:</p>
<ul>
<li><a href="qtnetwork-fortuneclient-client-cpp.html">fortuneclient/client.cpp</a></li>
<li><a href="qtnetwork-fortuneclient-client-h.html">fortuneclient/client.h</a></li>
<li><a href="qtnetwork-fortuneclient-main-cpp.html">fortuneclient/main.cpp</a></li>
<li><a href="qtnetwork-fortuneclient-fortuneclient-pro.html">fortuneclient/fortuneclient.pro</a></li>
</ul>
</div>
<p><b>See also </b><a href="qtnetwork-fortuneserver-example.html">Fortune Server Example</a> and <a href="qtnetwork-blockingfortuneclient-example.html">Blocking Fortune Client Example</a>.</p>
<!-- @@@fortuneclient -->
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> 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.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
distrib
>
Mageia
>
6
>
armv5tl
>
media
>
core-updates
>
by-pkgid
>
768f7d9f703884aa2562bf0a651086df
>
files
>
1902
