You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tqt3/doc/html/qhttprequestheader.html

158 lines
9.3 KiB

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/network/qhttp.cpp:836 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>TQHttpRequestHeader Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
<a href="index.html">
<font color="#004faf">Home</font></a>
| <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
| <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
| <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
| <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
| <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>TQHttpRequestHeader Class Reference<br><small>[<a href="network.html">network module</a>]</small></h1>
<p>The TQHttpRequestHeader class contains request header information for
HTTP.
<a href="#details">More...</a>
<p><tt>#include &lt;<a href="qhttp-h.html">ntqhttp.h</a>&gt;</tt>
<p>Inherits <a href="qhttpheader.html">TQHttpHeader</a>.
<p><a href="qhttprequestheader-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn><a href="#TQHttpRequestHeader"><b>TQHttpRequestHeader</b></a> ()</li>
<li class=fn><a href="#TQHttpRequestHeader-2"><b>TQHttpRequestHeader</b></a> ( const&nbsp;TQString&nbsp;&amp;&nbsp;method, const&nbsp;TQString&nbsp;&amp;&nbsp;path, int&nbsp;majorVer = 1, int&nbsp;minorVer = 1 )</li>
<li class=fn><a href="#TQHttpRequestHeader-3"><b>TQHttpRequestHeader</b></a> ( const&nbsp;TQHttpRequestHeader&nbsp;&amp;&nbsp;header )</li>
<li class=fn><a href="#TQHttpRequestHeader-4"><b>TQHttpRequestHeader</b></a> ( const&nbsp;TQString&nbsp;&amp;&nbsp;str )</li>
<li class=fn>void <a href="#setRequest"><b>setRequest</b></a> ( const&nbsp;TQString&nbsp;&amp;&nbsp;method, const&nbsp;TQString&nbsp;&amp;&nbsp;path, int&nbsp;majorVer = 1, int&nbsp;minorVer = 1 )</li>
<li class=fn>TQString <a href="#method"><b>method</b></a> () const</li>
<li class=fn>TQString <a href="#path"><b>path</b></a> () const</li>
<li class=fn>virtual int <a href="#majorVersion"><b>majorVersion</b></a> () const</li>
<li class=fn>virtual int <a href="#minorVersion"><b>minorVersion</b></a> () const</li>
</ul>
<h2>Important Inherited Members</h2>
<ul>
<li class=fn>TQString <a href="#value"><b>value</b></a> ( const&nbsp;TQString&nbsp;&amp;&nbsp;key ) const</li>
<li class=fn>void <a href="#setValue"><b>setValue</b></a> ( const&nbsp;TQString&nbsp;&amp;&nbsp;key, const&nbsp;TQString&nbsp;&amp;&nbsp;value )</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>
The TQHttpRequestHeader class contains request header information for
HTTP.
<p>
<p> This class is used in the <a href="ntqhttp.html">TQHttp</a> class to report the header
information if the client requests something from the server.
<p> HTTP requests have a method which describes the request's action.
The most common requests are "GET" and "POST". In addition to the
request method the header also includes a request-URI to specify
the location for the method to use.
<p> The method, request-URI and protocol-version can be set using a
constructor or later using <a href="#setRequest">setRequest</a>(). The values can be
obtained using <a href="#method">method</a>(), <a href="#path">path</a>(), <a href="#majorVersion">majorVersion</a>() and
<a href="#minorVersion">minorVersion</a>().
<p> This class is a <a href="qhttpheader.html">TQHttpHeader</a> subclass so that class's functions,
e.g. <a href="qhttpheader.html#setValue">setValue()</a>, <a href="qhttpheader.html#value">value()</a>, etc. are also available.
<p> <p>See also <a href="qhttpresponseheader.html">TQHttpResponseHeader</a>, <a href="ntqhttp.html">TQHttp</a>, and <a href="io.html">Input/Output and Networking</a>.
<p>
<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="TQHttpRequestHeader"></a>TQHttpRequestHeader::TQHttpRequestHeader ()
</h3>
Constructs an empty HTTP request header.
<h3 class=fn><a name="TQHttpRequestHeader-2"></a>TQHttpRequestHeader::TQHttpRequestHeader ( const&nbsp;<a href="tqstring.html">TQString</a>&nbsp;&amp;&nbsp;method, const&nbsp;<a href="tqstring.html">TQString</a>&nbsp;&amp;&nbsp;path, int&nbsp;majorVer = 1, int&nbsp;minorVer = 1 )
</h3>
Constructs a HTTP request header for the method <em>method</em>, the
request-URI <em>path</em> and the protocol-version <em>majorVer</em> and <em>minorVer</em>.
<h3 class=fn><a name="TQHttpRequestHeader-3"></a>TQHttpRequestHeader::TQHttpRequestHeader ( const&nbsp;<a href="qhttprequestheader.html">TQHttpRequestHeader</a>&nbsp;&amp;&nbsp;header )
</h3>
Constructs a copy of <em>header</em>.
<h3 class=fn><a name="TQHttpRequestHeader-4"></a>TQHttpRequestHeader::TQHttpRequestHeader ( const&nbsp;<a href="tqstring.html">TQString</a>&nbsp;&amp;&nbsp;str )
</h3>
Constructs a HTTP request header from the string <em>str</em>. The <em>str</em> should consist of one or more "\r\n" delimited lines; the first line
should be the request-line (format: method, space, request-URI, space
HTTP-version); each of the remaining lines should have the format key,
colon, space, value.
<h3 class=fn>int <a name="majorVersion"></a>TQHttpRequestHeader::majorVersion () const<tt> [virtual]</tt>
</h3>
Returns the major protocol-version of the HTTP request header.
<p> <p>See also <a href="#minorVersion">minorVersion</a>(), <a href="#method">method</a>(), <a href="#path">path</a>(), and <a href="#setRequest">setRequest</a>().
<p>Reimplemented from <a href="qhttpheader.html#majorVersion">TQHttpHeader</a>.
<h3 class=fn><a href="tqstring.html">TQString</a> <a name="method"></a>TQHttpRequestHeader::method () const
</h3>
Returns the method of the HTTP request header.
<p> <p>See also <a href="#path">path</a>(), <a href="#majorVersion">majorVersion</a>(), <a href="#minorVersion">minorVersion</a>(), and <a href="#setRequest">setRequest</a>().
<h3 class=fn>int <a name="minorVersion"></a>TQHttpRequestHeader::minorVersion () const<tt> [virtual]</tt>
</h3>
Returns the minor protocol-version of the HTTP request header.
<p> <p>See also <a href="#majorVersion">majorVersion</a>(), <a href="#method">method</a>(), <a href="#path">path</a>(), and <a href="#setRequest">setRequest</a>().
<p>Reimplemented from <a href="qhttpheader.html#minorVersion">TQHttpHeader</a>.
<h3 class=fn><a href="tqstring.html">TQString</a> <a name="path"></a>TQHttpRequestHeader::path () const
</h3>
Returns the request-URI of the HTTP request header.
<p> <p>See also <a href="#method">method</a>(), <a href="#majorVersion">majorVersion</a>(), <a href="#minorVersion">minorVersion</a>(), and <a href="#setRequest">setRequest</a>().
<h3 class=fn>void <a name="setRequest"></a>TQHttpRequestHeader::setRequest ( const&nbsp;<a href="tqstring.html">TQString</a>&nbsp;&amp;&nbsp;method, const&nbsp;<a href="tqstring.html">TQString</a>&nbsp;&amp;&nbsp;path, int&nbsp;majorVer = 1, int&nbsp;minorVer = 1 )
</h3>
This function sets the request method to <em>method</em>, the
request-URI to <em>path</em> and the protocol-version to <em>majorVer</em> and
<em>minorVer</em>.
<p> <p>See also <a href="#method">method</a>(), <a href="#path">path</a>(), <a href="#majorVersion">majorVersion</a>(), and <a href="#minorVersion">minorVersion</a>().
<h3 class=fn>void <a name="setValue"></a>TQHttpHeader::setValue ( const&nbsp;<a href="tqstring.html">TQString</a>&nbsp;&amp;&nbsp;key, const&nbsp;<a href="tqstring.html">TQString</a>&nbsp;&amp;&nbsp;value )
</h3>
Sets the value of the entry with the <em>key</em> to <em>value</em>.
<p> If no entry with <em>key</em> exists, a new entry with the given <em>key</em>
and <em>value</em> is created. If an entry with the <em>key</em> already
exists, its value is discarded and replaced with the given <em>value</em>.
<p> <p>See also <a href="qhttpheader.html#value">value</a>(), <a href="qhttpheader.html#hasKey">hasKey</a>(), and <a href="qhttpheader.html#removeValue">removeValue</a>().
<p>Example: <a href="archivesearch-example.html#x476">network/archivesearch/archivedialog.ui.h</a>.
<h3 class=fn><a href="tqstring.html">TQString</a> <a name="value"></a>TQHttpHeader::value ( const&nbsp;<a href="tqstring.html">TQString</a>&nbsp;&amp;&nbsp;key ) const
</h3>
Returns the value for the entry with the given <em>key</em>. If no entry
has this <em>key</em>, an empty string is returned.
<p> <p>See also <a href="qhttpheader.html#setValue">setValue</a>(), <a href="qhttpheader.html#removeValue">removeValue</a>(), <a href="qhttpheader.html#hasKey">hasKey</a>(), and <a href="qhttpheader.html#keys">keys</a>().
<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">TQt toolkit</a>.
Copyright &copy; 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>TQt 3.3.8</div>
</table></div></address></body>
</html>