<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- qhttp.cpp -->
<head>
<title>Qt 4.6: QHttp Class Reference</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<a name="//apple_ref/cpp/cl//QHttp"></a>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://qt.nokia.com/"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
<td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="functions.html"><font color="#004faf">All Functions</font></a> · <a href="overviews.html"><font color="#004faf">Overviews</font></a></td></tr></table><h1 class="title">QHttp Class Reference<br /><span class="small-subtitle">[<a href="qtnetwork.html">QtNetwork</a> module]</span>
</h1>
<p>The QHttp class provides an implementation of the HTTP protocol. <a href="#details">More...</a></p>
<pre> #include <QHttp></pre><p><b>This class is obsolete.</b> It is provided to keep old source code working. We strongly advise against using it in new code.</p>
<p><b>This class is not part of the Qt GUI Framework Edition.</b></p>
<p>Inherits <a href="qobject.html">QObject</a>.</p>
<p><b>Note:</b> All functions in this class are <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p>
<ul>
<li><a href="qhttp-members.html">List of all members, including inherited members</a></li>
<li><a href="qhttp-obsolete.html">Obsolete members</a></li>
<li><a href="qhttp-qt3.html">Qt 3 support members</a></li>
</ul>
<hr />
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#ConnectionMode-enum">ConnectionMode</a></b> { ConnectionModeHttp, ConnectionModeHttps }</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#Error-enum">Error</a></b> { NoError, HostNotFound, ConnectionRefused, UnexpectedClose, ..., UnknownError }</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#State-enum">State</a></b> { Unconnected, HostLookup, Connecting, Sending, ..., Closing }</td></tr>
</table>
<hr />
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#QHttp">QHttp</a></b> ( QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#QHttp-2">QHttp</a></b> ( const QString & <i>hostName</i>, quint16 <i>port</i> = 80, QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#QHttp-3">QHttp</a></b> ( const QString & <i>hostName</i>, ConnectionMode <i>mode</i>, quint16 <i>port</i> = 0, QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#dtor.QHttp">~QHttp</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">qint64 </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#bytesAvailable">bytesAvailable</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#clearPendingRequests">clearPendingRequests</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#close">close</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QIODevice * </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#currentDestinationDevice">currentDestinationDevice</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#currentId">currentId</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QHttpRequestHeader </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#currentRequest">currentRequest</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QIODevice * </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#currentSourceDevice">currentSourceDevice</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Error </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#error">error</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#errorString">errorString</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#get">get</a></b> ( const QString & <i>path</i>, QIODevice * <i>to</i> = 0 )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#hasPendingRequests">hasPendingRequests</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#head">head</a></b> ( const QString & <i>path</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QHttpResponseHeader </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#lastResponse">lastResponse</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#post">post</a></b> ( const QString & <i>path</i>, QIODevice * <i>data</i>, QIODevice * <i>to</i> = 0 )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#post-2">post</a></b> ( const QString & <i>path</i>, const QByteArray & <i>data</i>, QIODevice * <i>to</i> = 0 )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">qint64 </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#read">read</a></b> ( char * <i>data</i>, qint64 <i>maxlen</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QByteArray </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#readAll">readAll</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#request">request</a></b> ( const QHttpRequestHeader & <i>header</i>, QIODevice * <i>data</i> = 0, QIODevice * <i>to</i> = 0 )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#request-2">request</a></b> ( const QHttpRequestHeader & <i>header</i>, const QByteArray & <i>data</i>, QIODevice * <i>to</i> = 0 )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#setHost">setHost</a></b> ( const QString & <i>hostName</i>, quint16 <i>port</i> = 80 )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#setHost-2">setHost</a></b> ( const QString & <i>hostName</i>, ConnectionMode <i>mode</i>, quint16 <i>port</i> = 0 )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#setProxy">setProxy</a></b> ( const QString & <i>host</i>, int <i>port</i>, const QString & <i>username</i> = QString(), const QString & <i>password</i> = QString() )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#setProxy-2">setProxy</a></b> ( const QNetworkProxy & <i>proxy</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#setSocket">setSocket</a></b> ( QTcpSocket * <i>socket</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#setUser">setUser</a></b> ( const QString & <i>userName</i>, const QString & <i>password</i> = QString() )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">State </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#state">state</a></b> () const</td></tr>
</table>
<ul>
<li><div bar="2" class="fn"></div>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
</ul>
<hr />
<a name="public-slots"></a>
<h2>Public Slots</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#abort">abort</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#ignoreSslErrors">ignoreSslErrors</a></b> ()</td></tr>
</table>
<ul>
<li><div bar="2" class="fn"></div>1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
</ul>
<hr />
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#authenticationRequired">authenticationRequired</a></b> ( const QString & <i>hostname</i>, quint16 <i>port</i>, QAuthenticator * <i>authenticator</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#dataReadProgress">dataReadProgress</a></b> ( int <i>done</i>, int <i>total</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#dataSendProgress">dataSendProgress</a></b> ( int <i>done</i>, int <i>total</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#done">done</a></b> ( bool <i>error</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#proxyAuthenticationRequired">proxyAuthenticationRequired</a></b> ( const QNetworkProxy & <i>proxy</i>, QAuthenticator * <i>authenticator</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#readyRead">readyRead</a></b> ( const QHttpResponseHeader & <i>resp</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#requestFinished">requestFinished</a></b> ( int <i>id</i>, bool <i>error</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#requestStarted">requestStarted</a></b> ( int <i>id</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#responseHeaderReceived">responseHeaderReceived</a></b> ( const QHttpResponseHeader & <i>resp</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#sslErrors">sslErrors</a></b> ( const QList<QSslError> & <i>errors</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qhttp.html#stateChanged">stateChanged</a></b> ( int <i>state</i> )</td></tr>
</table>
<ul>
<li><div bar="2" class="fn"></div>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li><div class="fn"></div>1 property inherited from <a href="qobject.html#properties">QObject</a></li>
<li><div class="fn"></div>5 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
<li><div class="fn"></div>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QHttp class provides an implementation of the HTTP protocol.</p>
<p>This class provides a direct interface to HTTP that allows you to download and upload data with the HTTP protocol. However, for new applications, it is recommended to use <a href="qnetworkaccessmanager.html">QNetworkAccessManager</a> and <a href="qnetworkreply.html">QNetworkReply</a>, as those classes possess a simpler, yet more powerful API and a more modern protocol implementation.</p>
<p>The class works asynchronously, so there are no blocking functions. If an operation cannot be executed immediately, the function will still return straight away and the operation will be scheduled for later execution. The results of scheduled operations are reported via signals. This approach depends on the event loop being in operation.</p>
<p>The operations that can be scheduled (they are called "requests" in the rest of the documentation) are the following: <a href="qhttp.html#setHost">setHost</a>(), <a href="qhttp.html#get">get</a>(), <a href="qhttp.html#post">post</a>(), <a href="qhttp.html#head">head</a>() and <a href="qhttp.html#request">request</a>().</p>
<p>All of these requests return a unique identifier that allows you to keep track of the request that is currently executed. When the execution of a request starts, the <a href="qhttp.html#requestStarted">requestStarted</a>() signal with the identifier is emitted and when the request is finished, the <a href="qhttp.html#requestFinished">requestFinished</a>() signal is emitted with the identifier and a bool that indicates if the request finished with an error.</p>
<p>To make an HTTP request you must set up suitable HTTP headers. The following example demonstrates how to request the main HTML page from the Qt website (i.e., the URL <tt>http:<span class="comment">//qt.nokia.com/index.html</span></tt>):</p>
<pre> QHttpRequestHeader header("GET", QUrl::toPercentEncoding("/index.html"));
header.setValue("Host", "qt.nokia.com");
http->setHost("qt.nokia.com");
http->request(header);</pre>
<p>For the common HTTP requests <tt>GET</tt>, <tt>POST</tt> and <tt>HEAD</tt>, QHttp provides the convenience functions <a href="qhttp.html#get">get</a>(), <a href="qhttp.html#post">post</a>() and <a href="qhttp.html#head">head</a>(). They already use a reasonable header and if you don't have to set special header fields, they are easier to use. The above example can also be written as:</p>
<pre> http->setHost("qt.nokia.com"); <span class="comment">// id == 1</span>
http->get(QUrl::toPercentEncoding("/index.html")); <span class="comment">// id == 2</span></pre>
<p>For this example the following sequence of signals is emitted (with small variations, depending on network traffic, etc.):</p>
<pre> requestStarted(1)
requestFinished(1, false)
requestStarted(2)
stateChanged(Connecting)
stateChanged(Sending)
dataSendProgress(77, 77)
stateChanged(Reading)
responseHeaderReceived(responseheader)
dataReadProgress(5388, 0)
readyRead(responseheader)
dataReadProgress(18300, 0)
readyRead(responseheader)
stateChanged(Connected)
requestFinished(2, false)
done(false)
stateChanged(Closing)
stateChanged(Unconnected)</pre>
<p>The <a href="qhttp.html#dataSendProgress">dataSendProgress</a>() and <a href="qhttp.html#dataReadProgress">dataReadProgress</a>() signals in the above example are useful if you want to show a <a href="qprogressbar.html">progress bar</a> to inform the user about the progress of the download. The second argument is the total size of data. In certain cases it is not possible to know the total amount in advance, in which case the second argument is 0. (If you connect to a <a href="qprogressbar.html">QProgressBar</a> a total of 0 results in a busy indicator.)</p>
<p>When the response header is read, it is reported with the <a href="qhttp.html#responseHeaderReceived">responseHeaderReceived</a>() signal.</p>
<p>The <a href="qhttp.html#readyRead">readyRead</a>() signal tells you that there is data ready to be read. The amount of data can then be queried with the <a href="qhttp.html#bytesAvailable">bytesAvailable</a>() function and it can be read with the <a href="qhttp.html#read">read</a>() or <a href="qhttp.html#readAll">readAll</a>() functions.</p>
<p>If an error occurs during the execution of one of the commands in a sequence of commands, all the pending commands (i.e. scheduled, but not yet executed commands) are cleared and no signals are emitted for them.</p>
<p>For example, if you have the following sequence of requests</p>
<pre> http->setHost("www.foo.bar"); <span class="comment">// id == 1</span>
http->get("/index.html"); <span class="comment">// id == 2</span>
http->post("register.html", data); <span class="comment">// id == 3</span></pre>
<p>and the <a href="qhttp.html#get">get</a>() request fails because the host lookup fails, then the <a href="qhttp.html#post">post</a>() request is never executed and the signals would look like this:</p>
<pre> requestStarted(1)
requestFinished(1, false)
requestStarted(2)
stateChanged(HostLookup)
requestFinished(2, true)
done(true)
stateChanged(Unconnected)</pre>
<p>You can then get details about the error with the <a href="qhttp.html#error">error</a>() and <a href="qhttp.html#errorString">errorString</a>() functions. Note that only unexpected behavior, like network failure is considered as an error. If the server response contains an error status, like a 404 response, this is reported as a normal response case. So you should always check the <a href="qhttpresponseheader.html#statusCode">status code</a> of the response header.</p>
<p>The functions <a href="qhttp.html#currentId">currentId</a>() and <a href="qhttp.html#currentRequest">currentRequest</a>() provide more information about the currently executing request.</p>
<p>The functions <a href="qhttp.html#hasPendingRequests">hasPendingRequests</a>() and <a href="qhttp.html#clearPendingRequests">clearPendingRequests</a>() allow you to query and clear the list of pending requests.</p>
<p>See also <a href="qftp.html">QFtp</a>, <a href="qnetworkaccessmanager.html">QNetworkAccessManager</a>, <a href="qnetworkrequest.html">QNetworkRequest</a>, <a href="qnetworkreply.html">QNetworkReply</a>, <a href="network-http.html">HTTP Example</a>, and <a href="network-torrent.html">Torrent Example</a>.</p>
<hr />
<h2>Member Type Documentation</h2>
<a name="//apple_ref/cpp/tag/QHttp/ConnectionMode"></a>
<a name="//apple_ref/cpp/econst/QHttp/ConnectionModeHttp"></a>
<a name="//apple_ref/cpp/econst/QHttp/ConnectionModeHttps"></a>
<h3 class="fn"><a name="ConnectionMode-enum"></a>enum QHttp::ConnectionMode</h3>
<p>This enum is used to specify the mode of connection to use:</p>
<p><table class="valuelist" border="1" cellpadding="2" cellspacing="1" width="100%">
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
<tr><td valign="top"><tt>QHttp::ConnectionModeHttp</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">The connection is a regular HTTP connection to the server</td></tr>
<tr><td valign="top"><tt>QHttp::ConnectionModeHttps</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">The HTTPS protocol is used and the connection is encrypted using SSL.</td></tr>
</table></p>
<p>When using the HTTPS mode, care should be taken to connect to the sslErrors signal, and handle possible SSL errors.</p>
<p>This enum was introduced in Qt 4.3.</p>
<p>See also <a href="qsslsocket.html">QSslSocket</a>.</p>
<a name="//apple_ref/cpp/tag/QHttp/Error"></a>
<a name="//apple_ref/cpp/econst/QHttp/NoError"></a>
<a name="//apple_ref/cpp/econst/QHttp/HostNotFound"></a>
<a name="//apple_ref/cpp/econst/QHttp/ConnectionRefused"></a>
<a name="//apple_ref/cpp/econst/QHttp/UnexpectedClose"></a>
<a name="//apple_ref/cpp/econst/QHttp/InvalidResponseHeader"></a>
<a name="//apple_ref/cpp/econst/QHttp/WrongContentLength"></a>
<a name="//apple_ref/cpp/econst/QHttp/Aborted"></a>
<a name="//apple_ref/cpp/econst/QHttp/ProxyAuthenticationRequiredError"></a>
<a name="//apple_ref/cpp/econst/QHttp/AuthenticationRequiredError"></a>
<a name="//apple_ref/cpp/econst/QHttp/UnknownError"></a>
<h3 class="fn"><a name="Error-enum"></a>enum QHttp::Error</h3>
<p>This enum identifies the error that occurred.</p>
<p><table class="valuelist" border="1" cellpadding="2" cellspacing="1" width="100%">
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
<tr><td valign="top"><tt>QHttp::NoError</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">No error occurred.</td></tr>
<tr><td valign="top"><tt>QHttp::HostNotFound</tt></td><td align="center" valign="top"><tt>2</tt></td><td valign="top">The host name lookup failed.</td></tr>
<tr><td valign="top"><tt>QHttp::ConnectionRefused</tt></td><td align="center" valign="top"><tt>3</tt></td><td valign="top">The server refused the connection.</td></tr>
<tr><td valign="top"><tt>QHttp::UnexpectedClose</tt></td><td align="center" valign="top"><tt>4</tt></td><td valign="top">The server closed the connection unexpectedly.</td></tr>
<tr><td valign="top"><tt>QHttp::InvalidResponseHeader</tt></td><td align="center" valign="top"><tt>5</tt></td><td valign="top">The server sent an invalid response header.</td></tr>
<tr><td valign="top"><tt>QHttp::WrongContentLength</tt></td><td align="center" valign="top"><tt>6</tt></td><td valign="top">The client could not read the content correctly because an error with respect to the content length occurred.</td></tr>
<tr><td valign="top"><tt>QHttp::Aborted</tt></td><td align="center" valign="top"><tt>7</tt></td><td valign="top">The request was aborted with <a href="qhttp.html#abort">abort</a>().</td></tr>
<tr><td valign="top"><tt>QHttp::ProxyAuthenticationRequiredError</tt></td><td align="center" valign="top"><tt>9</tt></td><td valign="top"><a href="qhttp.html" class="obsolete">QHttp</a> is using a proxy, and the proxy server requires authentication to establish a connection.</td></tr>
<tr><td valign="top"><tt>QHttp::AuthenticationRequiredError</tt></td><td align="center" valign="top"><tt>8</tt></td><td valign="top">The web server requires authentication to complete the request.</td></tr>
<tr><td valign="top"><tt>QHttp::UnknownError</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">An error other than those specified above occurred.</td></tr>
</table></p>
<p>See also <a href="qhttp.html#error">error</a>().</p>
<a name="//apple_ref/cpp/tag/QHttp/State"></a>
<a name="//apple_ref/cpp/econst/QHttp/Unconnected"></a>
<a name="//apple_ref/cpp/econst/QHttp/HostLookup"></a>
<a name="//apple_ref/cpp/econst/QHttp/Connecting"></a>
<a name="//apple_ref/cpp/econst/QHttp/Sending"></a>
<a name="//apple_ref/cpp/econst/QHttp/Reading"></a>
<a name="//apple_ref/cpp/econst/QHttp/Connected"></a>
<a name="//apple_ref/cpp/econst/QHttp/Closing"></a>
<h3 class="fn"><a name="State-enum"></a>enum QHttp::State</h3>
<p>This enum is used to specify the state the client is in:</p>
<p><table class="valuelist" border="1" cellpadding="2" cellspacing="1" width="100%">
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
<tr><td valign="top"><tt>QHttp::Unconnected</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">There is no connection to the host.</td></tr>
<tr><td valign="top"><tt>QHttp::HostLookup</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">A host name lookup is in progress.</td></tr>
<tr><td valign="top"><tt>QHttp::Connecting</tt></td><td align="center" valign="top"><tt>2</tt></td><td valign="top">An attempt to connect to the host is in progress.</td></tr>
<tr><td valign="top"><tt>QHttp::Sending</tt></td><td align="center" valign="top"><tt>3</tt></td><td valign="top">The client is sending its request to the server.</td></tr>
<tr><td valign="top"><tt>QHttp::Reading</tt></td><td align="center" valign="top"><tt>4</tt></td><td valign="top">The client's request has been sent and the client is reading the server's response.</td></tr>
<tr><td valign="top"><tt>QHttp::Connected</tt></td><td align="center" valign="top"><tt>5</tt></td><td valign="top">The connection to the host is open, but the client is neither sending a request, nor waiting for a response.</td></tr>
<tr><td valign="top"><tt>QHttp::Closing</tt></td><td align="center" valign="top"><tt>6</tt></td><td valign="top">The connection is closing down, but is not yet closed. (The state will be <tt>Unconnected</tt> when the connection is closed.)</td></tr>
</table></p>
<p>See also <a href="qhttp.html#stateChanged">stateChanged</a>() and <a href="qhttp.html#state">state</a>().</p>
<hr />
<h2>Member Function Documentation</h2>
<a name="//apple_ref/cpp/instm/QHttp/QHttp"></a>
<h3 class="fn"><a name="QHttp"></a>QHttp::QHttp ( <a href="qobject.html">QObject</a> * <i>parent</i> = 0 )</h3>
<p>Constructs a <a href="qhttp.html" class="obsolete">QHttp</a> object. The <i>parent</i> parameter is passed on to the <a href="qobject.html">QObject</a> constructor.</p>
<h3 class="fn"><a name="QHttp-2"></a>QHttp::QHttp ( const <a href="qstring.html">QString</a> & <i>hostName</i>, <a href="qtglobal.html#quint16-typedef">quint16</a> <i>port</i> = 80, <a href="qobject.html">QObject</a> * <i>parent</i> = 0 )</h3>
<p>Constructs a <a href="qhttp.html" class="obsolete">QHttp</a> object. Subsequent requests are done by connecting to the server <i>hostName</i> on port <i>port</i>.</p>
<p>The <i>parent</i> parameter is passed on to the <a href="qobject.html">QObject</a> constructor.</p>
<p>See also <a href="qhttp.html#setHost">setHost</a>().</p>
<h3 class="fn"><a name="QHttp-3"></a>QHttp::QHttp ( const <a href="qstring.html">QString</a> & <i>hostName</i>, <a href="qhttp.html#ConnectionMode-enum">ConnectionMode</a> <i>mode</i>, <a href="qtglobal.html#quint16-typedef">quint16</a> <i>port</i> = 0, <a href="qobject.html">QObject</a> * <i>parent</i> = 0 )</h3>
<p>Constructs a <a href="qhttp.html" class="obsolete">QHttp</a> object. Subsequent requests are done by connecting to the server <i>hostName</i> on port <i>port</i> using the connection mode <i>mode</i>.</p>
<p>If port is 0, it will use the default port for the <i>mode</i> used (80 for Http and 443 for Https).</p>
<p>The <i>parent</i> parameter is passed on to the <a href="qobject.html">QObject</a> constructor.</p>
<p>See also <a href="qhttp.html#setHost">setHost</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/~QHttp"></a>
<h3 class="fn"><a name="dtor.QHttp"></a>QHttp::~QHttp () <tt> [virtual]</tt></h3>
<p>Destroys the <a href="qhttp.html" class="obsolete">QHttp</a> object. If there is an open connection, it is closed.</p>
<a name="//apple_ref/cpp/instm/QHttp/abort"></a>
<h3 class="fn"><a name="abort"></a>void QHttp::abort () <tt> [slot]</tt></h3>
<p>Aborts the current request and deletes all scheduled requests.</p>
<p>For the current request, the <a href="qhttp.html#requestFinished">requestFinished</a>() signal with the <tt>error</tt> argument <tt>true</tt> is emitted. For all other requests that are affected by the abort(), no signals are emitted.</p>
<p>Since this slot also deletes the scheduled requests, there are no requests left and the <a href="qhttp.html#done">done</a>() signal is emitted (with the <tt>error</tt> argument <tt>true</tt>).</p>
<p>See also <a href="qhttp.html#clearPendingRequests">clearPendingRequests</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/authenticationRequired"></a>
<h3 class="fn"><a name="authenticationRequired"></a>void QHttp::authenticationRequired ( const <a href="qstring.html">QString</a> & <i>hostname</i>, <a href="qtglobal.html#quint16-typedef">quint16</a> <i>port</i>, <a href="qauthenticator.html">QAuthenticator</a> * <i>authenticator</i> ) <tt> [signal]</tt></h3>
<p>This signal can be emitted when a web server on a given <i>hostname</i> and <i>port</i> requires authentication. The <i>authenticator</i> object can then be filled in with the required details to allow authentication and continue the connection.</p>
<p><b>Note:</b> It is not possible to use a QueuedConnection to connect to this signal, as the connection will fail if the authenticator has not been filled in with new information when the signal returns.</p>
<p>This function was introduced in Qt 4.3.</p>
<p>See also <a href="qauthenticator.html">QAuthenticator</a> and <a href="qnetworkproxy.html">QNetworkProxy</a>.</p>
<a name="//apple_ref/cpp/instm/QHttp/bytesAvailable"></a>
<h3 class="fn"><a name="bytesAvailable"></a><a href="qtglobal.html#qint64-typedef">qint64</a> QHttp::bytesAvailable () const</h3>
<p>Returns the number of bytes that can be read from the response content at the moment.</p>
<p>See also <a href="qhttp.html#get">get</a>(), <a href="qhttp.html#post">post</a>(), <a href="qhttp.html#request">request</a>(), <a href="qhttp.html#readyRead">readyRead</a>(), <a href="qhttp.html#read">read</a>(), and <a href="qhttp.html#readAll">readAll</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/clearPendingRequests"></a>
<h3 class="fn"><a name="clearPendingRequests"></a>void QHttp::clearPendingRequests ()</h3>
<p>Deletes all pending requests from the list of scheduled requests. This does not affect the request that is being executed. If you want to stop this as well, use <a href="qhttp.html#abort">abort</a>().</p>
<p>See also <a href="qhttp.html#hasPendingRequests">hasPendingRequests</a>() and <a href="qhttp.html#abort">abort</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/close"></a>
<h3 class="fn"><a name="close"></a>int QHttp::close ()</h3>
<p>Closes the connection; this is useful if you have a keep-alive connection and want to close it.</p>
<p>For the requests issued with <a href="qhttp.html#get">get</a>(), <a href="qhttp.html#post">post</a>() and <a href="qhttp.html#head">head</a>(), <a href="qhttp.html" class="obsolete">QHttp</a> sets the connection to be keep-alive. You can also do this using the header you pass to the <a href="qhttp.html#request">request</a>() function. <a href="qhttp.html" class="obsolete">QHttp</a> only closes the connection to the HTTP server if the response header requires it to do so.</p>
<p>The function does not block; instead, it returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by <a href="qhttp.html#requestStarted">requestStarted</a>() and <a href="qhttp.html#requestFinished">requestFinished</a>().</p>
<p>When the request is started the <a href="qhttp.html#requestStarted">requestStarted</a>() signal is emitted. When it is finished the <a href="qhttp.html#requestFinished">requestFinished</a>() signal is emitted.</p>
<p>If you want to close the connection immediately, you have to use <a href="qhttp.html#abort">abort</a>() instead.</p>
<p>See also <a href="qhttp.html#stateChanged">stateChanged</a>(), <a href="qhttp.html#abort">abort</a>(), <a href="qhttp.html#requestStarted">requestStarted</a>(), <a href="qhttp.html#requestFinished">requestFinished</a>(), and <a href="qhttp.html#done">done</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/currentDestinationDevice"></a>
<h3 class="fn"><a name="currentDestinationDevice"></a><a href="qiodevice.html">QIODevice</a> * QHttp::currentDestinationDevice () const</h3>
<p>Returns the <a href="qiodevice.html">QIODevice</a> pointer that is used as to store the data of the HTTP request being executed. If there is no current request or if the request does not store the data to an IO device, this function returns 0.</p>
<p>This function can be used to delete the <a href="qiodevice.html">QIODevice</a> in the slot connected to the <a href="qhttp.html#requestFinished">requestFinished</a>() signal.</p>
<p>See also <a href="qhttp.html#currentSourceDevice">currentSourceDevice</a>(), <a href="qhttp.html#get">get</a>(), <a href="qhttp.html#post">post</a>(), and <a href="qhttp.html#request">request</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/currentId"></a>
<h3 class="fn"><a name="currentId"></a>int QHttp::currentId () const</h3>
<p>Returns the identifier of the HTTP request being executed or 0 if there is no request being executed (i.e. they've all finished).</p>
<p>See also <a href="qhttp.html#currentRequest">currentRequest</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/currentRequest"></a>
<h3 class="fn"><a name="currentRequest"></a><a href="qhttprequestheader.html">QHttpRequestHeader</a> QHttp::currentRequest () const</h3>
<p>Returns the request header of the HTTP request being executed. If the request is one issued by <a href="qhttp.html#setHost">setHost</a>() or <a href="qhttp.html#close">close</a>(), it returns an invalid request header, i.e. <a href="qhttpheader.html#isValid">QHttpRequestHeader::isValid</a>() returns false.</p>
<p>See also <a href="qhttp.html#currentId">currentId</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/currentSourceDevice"></a>
<h3 class="fn"><a name="currentSourceDevice"></a><a href="qiodevice.html">QIODevice</a> * QHttp::currentSourceDevice () const</h3>
<p>Returns the <a href="qiodevice.html">QIODevice</a> pointer that is used as the data source of the HTTP request being executed. If there is no current request or if the request does not use an IO device as the data source, this function returns 0.</p>
<p>This function can be used to delete the <a href="qiodevice.html">QIODevice</a> in the slot connected to the <a href="qhttp.html#requestFinished">requestFinished</a>() signal.</p>
<p>See also <a href="qhttp.html#currentDestinationDevice">currentDestinationDevice</a>(), <a href="qhttp.html#post">post</a>(), and <a href="qhttp.html#request">request</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/dataReadProgress"></a>
<h3 class="fn"><a name="dataReadProgress"></a>void QHttp::dataReadProgress ( int <i>done</i>, int <i>total</i> ) <tt> [signal]</tt></h3>
<p>This signal is emitted when this object reads data from a HTTP server to indicate the current progress of the download.</p>
<p><i>done</i> is the amount of data that has already arrived and <i>total</i> is the total amount of data. It is possible that the total amount of data that should be transferred cannot be determined, in which case <i>total</i> is 0.(If you connect to a <a href="qprogressbar.html">QProgressBar</a>, the progress bar shows a busy indicator if the total is 0).</p>
<p><b>Warning:</b> <i>done</i> and <i>total</i> are not necessarily the size in bytes, since for large files these values might need to be "scaled" to avoid overflow.</p>
<p>See also <a href="qhttp.html#dataSendProgress">dataSendProgress</a>(), <a href="qhttp.html#get">get</a>(), <a href="qhttp.html#post">post</a>(), <a href="qhttp.html#request">request</a>(), and <a href="qprogressbar.html">QProgressBar</a>.</p>
<a name="//apple_ref/cpp/instm/QHttp/dataSendProgress"></a>
<h3 class="fn"><a name="dataSendProgress"></a>void QHttp::dataSendProgress ( int <i>done</i>, int <i>total</i> ) <tt> [signal]</tt></h3>
<p>This signal is emitted when this object sends data to a HTTP server to inform it about the progress of the upload.</p>
<p><i>done</i> is the amount of data that has already arrived and <i>total</i> is the total amount of data. It is possible that the total amount of data that should be transferred cannot be determined, in which case <i>total</i> is 0.(If you connect to a <a href="qprogressbar.html">QProgressBar</a>, the progress bar shows a busy indicator if the total is 0).</p>
<p><b>Warning:</b> <i>done</i> and <i>total</i> are not necessarily the size in bytes, since for large files these values might need to be "scaled" to avoid overflow.</p>
<p>See also <a href="qhttp.html#dataReadProgress">dataReadProgress</a>(), <a href="qhttp.html#post">post</a>(), <a href="qhttp.html#request">request</a>(), and <a href="qprogressbar.html">QProgressBar</a>.</p>
<a name="//apple_ref/cpp/instm/QHttp/done"></a>
<h3 class="fn"><a name="done"></a>void QHttp::done ( bool <i>error</i> ) <tt> [signal]</tt></h3>
<p>This signal is emitted when the last pending request has finished; (it is emitted after the last request's <a href="qhttp.html#requestFinished">requestFinished</a>() signal). <i>error</i> is true if an error occurred during the processing; otherwise <i>error</i> is false.</p>
<p>See also <a href="qhttp.html#requestFinished">requestFinished</a>(), <a href="qhttp.html#error">error</a>(), and <a href="qhttp.html#errorString">errorString</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/error"></a>
<h3 class="fn"><a name="error"></a><a href="qhttp.html#Error-enum">Error</a> QHttp::error () const</h3>
<p>Returns the last error that occurred. This is useful to find out what happened when receiving a <a href="qhttp.html#requestFinished">requestFinished</a>() or a <a href="qhttp.html#done">done</a>() signal with the <tt>error</tt> argument <tt>true</tt>.</p>
<p>If you start a new request, the error status is reset to <tt>NoError</tt>.</p>
<a name="//apple_ref/cpp/instm/QHttp/errorString"></a>
<h3 class="fn"><a name="errorString"></a><a href="qstring.html">QString</a> QHttp::errorString () const</h3>
<p>Returns a human-readable description of the last error that occurred. This is useful to present a error message to the user when receiving a <a href="qhttp.html#requestFinished">requestFinished</a>() or a <a href="qhttp.html#done">done</a>() signal with the <tt>error</tt> argument <tt>true</tt>.</p>
<a name="//apple_ref/cpp/instm/QHttp/get"></a>
<h3 class="fn"><a name="get"></a>int QHttp::get ( const <a href="qstring.html">QString</a> & <i>path</i>, <a href="qiodevice.html">QIODevice</a> * <i>to</i> = 0 )</h3>
<p>Sends a get request for <i>path</i> to the server set by <a href="qhttp.html#setHost">setHost</a>() or as specified in the constructor.</p>
<p><i>path</i> must be a absolute path like <tt>/index.html</tt> or an absolute URI like <tt>http:<span class="comment">//example.com/index.html</span></tt> and must be encoded with either <a href="qurl.html#toPercentEncoding">QUrl::toPercentEncoding</a>() or <a href="qurl.html#encodedPath">QUrl::encodedPath</a>().</p>
<p>If the IO device <i>to</i> is 0 the <a href="qhttp.html#readyRead">readyRead</a>() signal is emitted every time new content data is available to read.</p>
<p>If the IO device <i>to</i> is not 0, the content data of the response is written directly to the device. Make sure that the <i>to</i> pointer is valid for the duration of the operation (it is safe to delete it when the <a href="qhttp.html#requestFinished">requestFinished</a>() signal is emitted).</p>
<a name="request-processing"></a>
<h4>Request Processing</h4>
<p>The function does not block; instead, it returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by <a href="qhttp.html#requestStarted">requestStarted</a>() and <a href="qhttp.html#requestFinished">requestFinished</a>().</p>
<p>When the request is started the <a href="qhttp.html#requestStarted">requestStarted</a>() signal is emitted. When it is finished the <a href="qhttp.html#requestFinished">requestFinished</a>() signal is emitted.</p>
<p>See also <a href="qhttp.html#setHost">setHost</a>(), <a href="qhttp.html#post">post</a>(), <a href="qhttp.html#head">head</a>(), <a href="qhttp.html#request">request</a>(), <a href="qhttp.html#requestStarted">requestStarted</a>(), <a href="qhttp.html#requestFinished">requestFinished</a>(), and <a href="qhttp.html#done">done</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/hasPendingRequests"></a>
<h3 class="fn"><a name="hasPendingRequests"></a>bool QHttp::hasPendingRequests () const</h3>
<p>Returns true if there are any requests scheduled that have not yet been executed; otherwise returns false.</p>
<p>The request that is being executed is <i>not</i> considered as a scheduled request.</p>
<p>See also <a href="qhttp.html#clearPendingRequests">clearPendingRequests</a>(), <a href="qhttp.html#currentId">currentId</a>(), and <a href="qhttp.html#currentRequest">currentRequest</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/head"></a>
<h3 class="fn"><a name="head"></a>int QHttp::head ( const <a href="qstring.html">QString</a> & <i>path</i> )</h3>
<p>Sends a header request for <i>path</i> to the server set by <a href="qhttp.html#setHost">setHost</a>() or as specified in the constructor.</p>
<p><i>path</i> must be an absolute path like <tt>/index.html</tt> or an absolute URI like <tt>http:<span class="comment">//example.com/index.html</span></tt>.</p>
<p>The function does not block; instead, it returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by <a href="qhttp.html#requestStarted">requestStarted</a>() and <a href="qhttp.html#requestFinished">requestFinished</a>().</p>
<p>When the request is started the <a href="qhttp.html#requestStarted">requestStarted</a>() signal is emitted. When it is finished the <a href="qhttp.html#requestFinished">requestFinished</a>() signal is emitted.</p>
<p>See also <a href="qhttp.html#setHost">setHost</a>(), <a href="qhttp.html#get">get</a>(), <a href="qhttp.html#post">post</a>(), <a href="qhttp.html#request">request</a>(), <a href="qhttp.html#requestStarted">requestStarted</a>(), <a href="qhttp.html#requestFinished">requestFinished</a>(), and <a href="qhttp.html#done">done</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/ignoreSslErrors"></a>
<h3 class="fn"><a name="ignoreSslErrors"></a>void QHttp::ignoreSslErrors () <tt> [slot]</tt></h3>
<p>Tells the <a href="qsslsocket.html">QSslSocket</a> used for the Http connection to ignore the errors reported in the <a href="qhttp.html#sslErrors">sslErrors</a>() signal.</p>
<p>Note that this function must be called from within a slot connected to the <a href="qhttp.html#sslErrors">sslErrors</a>() signal to have any effect.</p>
<p>See also <a href="qsslsocket.html">QSslSocket</a> and <a href="qsslsocket.html#sslErrors">QSslSocket::sslErrors</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/lastResponse"></a>
<h3 class="fn"><a name="lastResponse"></a><a href="qhttpresponseheader.html">QHttpResponseHeader</a> QHttp::lastResponse () const</h3>
<p>Returns the received response header of the most recently finished HTTP request. If no response has yet been received <a href="qhttpheader.html#isValid">QHttpResponseHeader::isValid</a>() will return false.</p>
<p>See also <a href="qhttp.html#currentRequest">currentRequest</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/post"></a>
<h3 class="fn"><a name="post"></a>int QHttp::post ( const <a href="qstring.html">QString</a> & <i>path</i>, <a href="qiodevice.html">QIODevice</a> * <i>data</i>, <a href="qiodevice.html">QIODevice</a> * <i>to</i> = 0 )</h3>
<p>Sends a post request for <i>path</i> to the server set by <a href="qhttp.html#setHost">setHost</a>() or as specified in the constructor.</p>
<p><i>path</i> must be an absolute path like <tt>/index.html</tt> or an absolute URI like <tt>http:<span class="comment">//example.com/index.html</span></tt> and must be encoded with either <a href="qurl.html#toPercentEncoding">QUrl::toPercentEncoding</a>() or <a href="qurl.html#encodedPath">QUrl::encodedPath</a>().</p>
<p>The incoming data comes via the <i>data</i> IO device.</p>
<p>If the IO device <i>to</i> is 0 the <a href="qhttp.html#readyRead">readyRead</a>() signal is emitted every time new content data is available to read.</p>
<p>If the IO device <i>to</i> is not 0, the content data of the response is written directly to the device. Make sure that the <i>to</i> pointer is valid for the duration of the operation (it is safe to delete it when the <a href="qhttp.html#requestFinished">requestFinished</a>() signal is emitted).</p>
<p>The function does not block; instead, it returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by <a href="qhttp.html#requestStarted">requestStarted</a>() and <a href="qhttp.html#requestFinished">requestFinished</a>().</p>
<p>When the request is started the <a href="qhttp.html#requestStarted">requestStarted</a>() signal is emitted. When it is finished the <a href="qhttp.html#requestFinished">requestFinished</a>() signal is emitted.</p>
<p>See also <a href="qhttp.html#setHost">setHost</a>(), <a href="qhttp.html#get">get</a>(), <a href="qhttp.html#head">head</a>(), <a href="qhttp.html#request">request</a>(), <a href="qhttp.html#requestStarted">requestStarted</a>(), <a href="qhttp.html#requestFinished">requestFinished</a>(), and <a href="qhttp.html#done">done</a>().</p>
<h3 class="fn"><a name="post-2"></a>int QHttp::post ( const <a href="qstring.html">QString</a> & <i>path</i>, const <a href="qbytearray.html">QByteArray</a> & <i>data</i>, <a href="qiodevice.html">QIODevice</a> * <i>to</i> = 0 )</h3>
<p>This is an overloaded function.</p>
<p><i>data</i> is used as the content data of the HTTP request.</p>
<a name="//apple_ref/cpp/instm/QHttp/proxyAuthenticationRequired"></a>
<h3 class="fn"><a name="proxyAuthenticationRequired"></a>void QHttp::proxyAuthenticationRequired ( const <a href="qnetworkproxy.html">QNetworkProxy</a> & <i>proxy</i>, <a href="qauthenticator.html">QAuthenticator</a> * <i>authenticator</i> ) <tt> [signal]</tt></h3>
<p>This signal can be emitted when a <i>proxy</i> that requires authentication is used. The <i>authenticator</i> object can then be filled in with the required details to allow authentication and continue the connection.</p>
<p><b>Note:</b> It is not possible to use a QueuedConnection to connect to this signal, as the connection will fail if the authenticator has not been filled in with new information when the signal returns.</p>
<p>This function was introduced in Qt 4.3.</p>
<p>See also <a href="qauthenticator.html">QAuthenticator</a> and <a href="qnetworkproxy.html">QNetworkProxy</a>.</p>
<a name="//apple_ref/cpp/instm/QHttp/read"></a>
<h3 class="fn"><a name="read"></a><a href="qtglobal.html#qint64-typedef">qint64</a> QHttp::read ( char * <i>data</i>, <a href="qtglobal.html#qint64-typedef">qint64</a> <i>maxlen</i> )</h3>
<p>Reads <i>maxlen</i> bytes from the response content into <i>data</i> and returns the number of bytes read. Returns -1 if an error occurred.</p>
<p>See also <a href="qhttp.html#get">get</a>(), <a href="qhttp.html#post">post</a>(), <a href="qhttp.html#request">request</a>(), <a href="qhttp.html#readyRead">readyRead</a>(), <a href="qhttp.html#bytesAvailable">bytesAvailable</a>(), and <a href="qhttp.html#readAll">readAll</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/readAll"></a>
<h3 class="fn"><a name="readAll"></a><a href="qbytearray.html">QByteArray</a> QHttp::readAll ()</h3>
<p>Reads all the bytes from the response content and returns them.</p>
<p>See also <a href="qhttp.html#get">get</a>(), <a href="qhttp.html#post">post</a>(), <a href="qhttp.html#request">request</a>(), <a href="qhttp.html#readyRead">readyRead</a>(), <a href="qhttp.html#bytesAvailable">bytesAvailable</a>(), and <a href="qhttp.html#read">read</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/readyRead"></a>
<h3 class="fn"><a name="readyRead"></a>void QHttp::readyRead ( const <a href="qhttpresponseheader.html">QHttpResponseHeader</a> & <i>resp</i> ) <tt> [signal]</tt></h3>
<p>This signal is emitted when there is new response data to read.</p>
<p>If you specified a device in the request where the data should be written to, then this signal is <i>not</i> emitted; instead the data is written directly to the device.</p>
<p>The response header is passed in <i>resp</i>.</p>
<p>You can read the data with the <a href="qhttp.html#readAll">readAll</a>() or <a href="qhttp.html#read">read</a>() functions</p>
<p>This signal is useful if you want to process the data in chunks as soon as it becomes available. If you are only interested in the complete data, just connect to the <a href="qhttp.html#requestFinished">requestFinished</a>() signal and read the data then instead.</p>
<p>See also <a href="qhttp.html#get">get</a>(), <a href="qhttp.html#post">post</a>(), <a href="qhttp.html#request">request</a>(), <a href="qhttp.html#readAll">readAll</a>(), <a href="qhttp.html#read">read</a>(), and <a href="qhttp.html#bytesAvailable">bytesAvailable</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/request"></a>
<h3 class="fn"><a name="request"></a>int QHttp::request ( const <a href="qhttprequestheader.html">QHttpRequestHeader</a> & <i>header</i>, <a href="qiodevice.html">QIODevice</a> * <i>data</i> = 0, <a href="qiodevice.html">QIODevice</a> * <i>to</i> = 0 )</h3>
<p>Sends a request to the server set by <a href="qhttp.html#setHost">setHost</a>() or as specified in the constructor. Uses the <i>header</i> as the HTTP request header. You are responsible for setting up a header that is appropriate for your request.</p>
<p>The incoming data comes via the <i>data</i> IO device.</p>
<p>If the IO device <i>to</i> is 0 the <a href="qhttp.html#readyRead">readyRead</a>() signal is emitted every time new content data is available to read.</p>
<p>If the IO device <i>to</i> is not 0, the content data of the response is written directly to the device. Make sure that the <i>to</i> pointer is valid for the duration of the operation (it is safe to delete it when the <a href="qhttp.html#requestFinished">requestFinished</a>() signal is emitted).</p>
<p>The function does not block; instead, it returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by <a href="qhttp.html#requestStarted">requestStarted</a>() and <a href="qhttp.html#requestFinished">requestFinished</a>().</p>
<p>When the request is started the <a href="qhttp.html#requestStarted">requestStarted</a>() signal is emitted. When it is finished the <a href="qhttp.html#requestFinished">requestFinished</a>() signal is emitted.</p>
<p>See also <a href="qhttp.html#setHost">setHost</a>(), <a href="qhttp.html#get">get</a>(), <a href="qhttp.html#post">post</a>(), <a href="qhttp.html#head">head</a>(), <a href="qhttp.html#requestStarted">requestStarted</a>(), <a href="qhttp.html#requestFinished">requestFinished</a>(), and <a href="qhttp.html#done">done</a>().</p>
<h3 class="fn"><a name="request-2"></a>int QHttp::request ( const <a href="qhttprequestheader.html">QHttpRequestHeader</a> & <i>header</i>, const <a href="qbytearray.html">QByteArray</a> & <i>data</i>, <a href="qiodevice.html">QIODevice</a> * <i>to</i> = 0 )</h3>
<p>This is an overloaded function.</p>
<p><i>data</i> is used as the content data of the HTTP request.</p>
<a name="//apple_ref/cpp/instm/QHttp/requestFinished"></a>
<h3 class="fn"><a name="requestFinished"></a>void QHttp::requestFinished ( int <i>id</i>, bool <i>error</i> ) <tt> [signal]</tt></h3>
<p>This signal is emitted when processing the request identified by <i>id</i> has finished. <i>error</i> is true if an error occurred during the processing; otherwise <i>error</i> is false.</p>
<p>See also <a href="qhttp.html#requestStarted">requestStarted</a>(), <a href="qhttp.html#done">done</a>(), <a href="qhttp.html#error">error</a>(), and <a href="qhttp.html#errorString">errorString</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/requestStarted"></a>
<h3 class="fn"><a name="requestStarted"></a>void QHttp::requestStarted ( int <i>id</i> ) <tt> [signal]</tt></h3>
<p>This signal is emitted when processing the request identified by <i>id</i> starts.</p>
<p>See also <a href="qhttp.html#requestFinished">requestFinished</a>() and <a href="qhttp.html#done">done</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/responseHeaderReceived"></a>
<h3 class="fn"><a name="responseHeaderReceived"></a>void QHttp::responseHeaderReceived ( const <a href="qhttpresponseheader.html">QHttpResponseHeader</a> & <i>resp</i> ) <tt> [signal]</tt></h3>
<p>This signal is emitted when the HTTP header of a server response is available. The header is passed in <i>resp</i>.</p>
<p>See also <a href="qhttp.html#get">get</a>(), <a href="qhttp.html#post">post</a>(), <a href="qhttp.html#head">head</a>(), <a href="qhttp.html#request">request</a>(), and <a href="qhttp.html#readyRead">readyRead</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/setHost"></a>
<h3 class="fn"><a name="setHost"></a>int QHttp::setHost ( const <a href="qstring.html">QString</a> & <i>hostName</i>, <a href="qtglobal.html#quint16-typedef">quint16</a> <i>port</i> = 80 )</h3>
<p>Sets the HTTP server that is used for requests to <i>hostName</i> on port <i>port</i>.</p>
<p>The function does not block; instead, it returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by <a href="qhttp.html#requestStarted">requestStarted</a>() and <a href="qhttp.html#requestFinished">requestFinished</a>().</p>
<p>When the request is started the <a href="qhttp.html#requestStarted">requestStarted</a>() signal is emitted. When it is finished the <a href="qhttp.html#requestFinished">requestFinished</a>() signal is emitted.</p>
<p>See also <a href="qhttp.html#get">get</a>(), <a href="qhttp.html#post">post</a>(), <a href="qhttp.html#head">head</a>(), <a href="qhttp.html#request">request</a>(), <a href="qhttp.html#requestStarted">requestStarted</a>(), <a href="qhttp.html#requestFinished">requestFinished</a>(), and <a href="qhttp.html#done">done</a>().</p>
<h3 class="fn"><a name="setHost-2"></a>int QHttp::setHost ( const <a href="qstring.html">QString</a> & <i>hostName</i>, <a href="qhttp.html#ConnectionMode-enum">ConnectionMode</a> <i>mode</i>, <a href="qtglobal.html#quint16-typedef">quint16</a> <i>port</i> = 0 )</h3>
<p>Sets the HTTP server that is used for requests to <i>hostName</i> on port <i>port</i> using the connection mode <i>mode</i>.</p>
<p>If port is 0, it will use the default port for the <i>mode</i> used (80 for HTTP and 443 for HTTPS).</p>
<p>The function does not block; instead, it returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by <a href="qhttp.html#requestStarted">requestStarted</a>() and <a href="qhttp.html#requestFinished">requestFinished</a>().</p>
<p>When the request is started the <a href="qhttp.html#requestStarted">requestStarted</a>() signal is emitted. When it is finished the <a href="qhttp.html#requestFinished">requestFinished</a>() signal is emitted.</p>
<p>See also <a href="qhttp.html#get">get</a>(), <a href="qhttp.html#post">post</a>(), <a href="qhttp.html#head">head</a>(), <a href="qhttp.html#request">request</a>(), <a href="qhttp.html#requestStarted">requestStarted</a>(), <a href="qhttp.html#requestFinished">requestFinished</a>(), and <a href="qhttp.html#done">done</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/setProxy"></a>
<h3 class="fn"><a name="setProxy"></a>int QHttp::setProxy ( const <a href="qstring.html">QString</a> & <i>host</i>, int <i>port</i>, const <a href="qstring.html">QString</a> & <i>username</i> = QString(), const <a href="qstring.html">QString</a> & <i>password</i> = QString() )</h3>
<p>Enables HTTP proxy support, using the proxy server <i>host</i> on port <i>port</i>. <i>username</i> and <i>password</i> can be provided if the proxy server requires authentication.</p>
<p>Example:</p>
<pre> void Ticker::getTicks()
{
http = new QHttp(this);
connect(http, SIGNAL(done(bool)), this, SLOT(showPage()));
http->setProxy("proxy.example.com", 3128);
http->setHost("ticker.example.com");
http->get("/ticks.asp");
}
void Ticker::showPage()
{
display(http->readAll());
}</pre>
<p><a href="qhttp.html" class="obsolete">QHttp</a> supports non-transparent web proxy servers only, such as the Squid Web proxy cache server (from <a href="http://www.squid.org/">http://www.squid.org/</a>). For transparent proxying, such as SOCKS5, use <a href="qnetworkproxy.html">QNetworkProxy</a> instead.</p>
<p><b>Note:</b> setProxy() has to be called before <a href="qhttp.html#setHost">setHost</a>() for it to take effect. If setProxy() is called after <a href="qhttp.html#setHost">setHost</a>(), then it will not apply until after <a href="qhttp.html#setHost">setHost</a>() is called again.</p>
<p>See also <a href="qftp.html#setProxy">QFtp::setProxy</a>().</p>
<h3 class="fn"><a name="setProxy-2"></a>int QHttp::setProxy ( const <a href="qnetworkproxy.html">QNetworkProxy</a> & <i>proxy</i> )</h3>
<p>This is an overloaded function.</p>
<p>Enables HTTP proxy support using the proxy settings from <i>proxy</i>. If <i>proxy</i> is a transparent proxy, <a href="qhttp.html" class="obsolete">QHttp</a> will call <a href="qabstractsocket.html#setProxy">QAbstractSocket::setProxy</a>() on the underlying socket. If the type is <a href="qnetworkproxy.html#ProxyType-enum">QNetworkProxy::HttpCachingProxy</a>, <a href="qhttp.html" class="obsolete">QHttp</a> will behave like the previous function.</p>
<p><b>Note:</b> for compatibility with Qt 4.3, if the proxy type is <a href="qnetworkproxy.html#ProxyType-enum">QNetworkProxy::HttpProxy</a> and the request type is unencrypted (that is, <a href="qhttp.html#ConnectionMode-enum">ConnectionModeHttp</a>), <a href="qhttp.html" class="obsolete">QHttp</a> will treat the proxy as a caching proxy.</p>
<a name="//apple_ref/cpp/instm/QHttp/setSocket"></a>
<h3 class="fn"><a name="setSocket"></a>int QHttp::setSocket ( <a href="qtcpsocket.html">QTcpSocket</a> * <i>socket</i> )</h3>
<p>Replaces the internal <a href="qtcpsocket.html">QTcpSocket</a> that <a href="qhttp.html" class="obsolete">QHttp</a> uses with <i>socket</i>. This is useful if you want to use your own custom <a href="qtcpsocket.html">QTcpSocket</a> subclass instead of the plain <a href="qtcpsocket.html">QTcpSocket</a> that <a href="qhttp.html" class="obsolete">QHttp</a> uses by default. <a href="qhttp.html" class="obsolete">QHttp</a> does not take ownership of the socket, and will not delete <i>socket</i> when destroyed.</p>
<p>The function does not block; instead, it returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by <a href="qhttp.html#requestStarted">requestStarted</a>() and <a href="qhttp.html#requestFinished">requestFinished</a>().</p>
<p>When the request is started the <a href="qhttp.html#requestStarted">requestStarted</a>() signal is emitted. When it is finished the <a href="qhttp.html#requestFinished">requestFinished</a>() signal is emitted.</p>
<p>Note: If <a href="qhttp.html" class="obsolete">QHttp</a> is used in a non-GUI thread that runs its own event loop, you must move <i>socket</i> to that thread before calling setSocket().</p>
<p>See also <a href="qobject.html#moveToThread">QObject::moveToThread</a>() and <a href="threads.html">Thread Support in Qt</a>.</p>
<a name="//apple_ref/cpp/instm/QHttp/setUser"></a>
<h3 class="fn"><a name="setUser"></a>int QHttp::setUser ( const <a href="qstring.html">QString</a> & <i>userName</i>, const <a href="qstring.html">QString</a> & <i>password</i> = QString() )</h3>
<p>This function sets the user name <i>userName</i> and password <i>password</i> for web pages that require authentication.</p>
<p>The function does not block; instead, it returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by <a href="qhttp.html#requestStarted">requestStarted</a>() and <a href="qhttp.html#requestFinished">requestFinished</a>().</p>
<p>When the request is started the <a href="qhttp.html#requestStarted">requestStarted</a>() signal is emitted. When it is finished the <a href="qhttp.html#requestFinished">requestFinished</a>() signal is emitted.</p>
<a name="//apple_ref/cpp/instm/QHttp/sslErrors"></a>
<h3 class="fn"><a name="sslErrors"></a>void QHttp::sslErrors ( const <a href="qlist.html">QList</a><<a href="qsslerror.html">QSslError</a>> & <i>errors</i> ) <tt> [signal]</tt></h3>
<p>Forwards the sslErrors signal from the <a href="qsslsocket.html">QSslSocket</a> used in <a href="qhttp.html" class="obsolete">QHttp</a>. <i>errors</i> is the list of errors that occurred during the SSL handshake. Unless you call <a href="qhttp.html#ignoreSslErrors">ignoreSslErrors</a>() from within a slot connected to this signal when an error occurs, <a href="qhttp.html" class="obsolete">QHttp</a> will tear down the connection immediately after emitting the signal.</p>
<p>This function was introduced in Qt 4.3.</p>
<p>See also <a href="qsslsocket.html">QSslSocket</a> and <a href="qsslsocket.html#ignoreSslErrors">QSslSocket::ignoreSslErrors</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/state"></a>
<h3 class="fn"><a name="state"></a><a href="qhttp.html#State-enum">State</a> QHttp::state () const</h3>
<p>Returns the current state of the object. When the state changes, the <a href="qhttp.html#stateChanged">stateChanged</a>() signal is emitted.</p>
<p>See also <a href="qhttp.html#State-enum">State</a> and <a href="qhttp.html#stateChanged">stateChanged</a>().</p>
<a name="//apple_ref/cpp/instm/QHttp/stateChanged"></a>
<h3 class="fn"><a name="stateChanged"></a>void QHttp::stateChanged ( int <i>state</i> ) <tt> [signal]</tt></h3>
<p>This signal is emitted when the state of the <a href="qhttp.html" class="obsolete">QHttp</a> object changes. The argument <i>state</i> is the new state of the connection; it is one of the <a href="qhttp.html#State-enum">State</a> values.</p>
<p>This usually happens when a request is started, but it can also happen when the server closes the connection or when a call to <a href="qhttp.html#close">close</a>() succeeded.</p>
<p>See also <a href="qhttp.html#get">get</a>(), <a href="qhttp.html#post">post</a>(), <a href="qhttp.html#head">head</a>(), <a href="qhttp.html#request">request</a>(), <a href="qhttp.html#close">close</a>(), <a href="qhttp.html#state">state</a>(), and <a href="qhttp.html#State-enum">State</a>.</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="40%" align="left">Copyright © 2010 Nokia Corporation and/or its subsidiary(-ies)</td>
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
<td width="40%" align="right"><div align="right">Qt 4.6.3</div></td>
</tr></table></div></address></body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
8e6051afcdb111a0317a58fb64c2abf5
>
files
>
4293
