<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /tmp/qt-3.0-reggie-28534/qt-x11-free-3.0.2/src/kernel/qnetworkprotocol.cpp:956 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QNetworkOperation Class</title>
<style type="text/css"><!--
h3.fn,span.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 Classes</font></a>
| <a href="mainclasses.html">
<font color="#004faf">Main Classes</font></a>
| <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
| <a href="groups.html">
<font color="#004faf">Grouped 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>QNetworkOperation Class Reference</h1>
<p>The QNetworkOperation class provides common operations for network protocols.
<a href="#details">More...</a>
<p><tt>#include <<a href="qnetworkprotocol-h.html">qnetworkprotocol.h</a>></tt>
<p>Inherits <a href="qobject.html">QObject</a>.
<p><a href="qnetworkoperation-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li><div class=fn><a href="#QNetworkOperation"><b>QNetworkOperation</b></a> ( QNetworkProtocol::Operation operation, const QString & arg0, const QString & arg1, const QString & arg2 )</div></li>
<li><div class=fn><a href="#QNetworkOperation-2"><b>QNetworkOperation</b></a> ( QNetworkProtocol::Operation operation, const QByteArray & arg0, const QByteArray & arg1, const QByteArray & arg2 )</div></li>
<li><div class=fn><a href="#~QNetworkOperation"><b>~QNetworkOperation</b></a> ()</div></li>
<li><div class=fn>void <a href="#setState"><b>setState</b></a> ( QNetworkProtocol::State state )</div></li>
<li><div class=fn>void <a href="#setProtocolDetail"><b>setProtocolDetail</b></a> ( const QString & detail )</div></li>
<li><div class=fn>void <a href="#setErrorCode"><b>setErrorCode</b></a> ( int ec )</div></li>
<li><div class=fn>void <a href="#setArg"><b>setArg</b></a> ( int num, const QString & arg )</div></li>
<li><div class=fn>void <a href="#setRawArg"><b>setRawArg</b></a> ( int num, const QByteArray & arg )</div></li>
<li><div class=fn>QNetworkProtocol::Operation <a href="#operation"><b>operation</b></a> () const</div></li>
<li><div class=fn>QNetworkProtocol::State <a href="#state"><b>state</b></a> () const</div></li>
<li><div class=fn>QString <a href="#arg"><b>arg</b></a> ( int num ) const</div></li>
<li><div class=fn>QByteArray <a href="#rawArg"><b>rawArg</b></a> ( int num ) const</div></li>
<li><div class=fn>QString <a href="#protocolDetail"><b>protocolDetail</b></a> () const</div></li>
<li><div class=fn>int <a href="#errorCode"><b>errorCode</b></a> () const</div></li>
<li><div class=fn>void <a href="#free"><b>free</b></a> ()</div></li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>
<p> The QNetworkOperation class provides common operations for network protocols.
<p>
<p> An object is created to describe the operation and the current
state for each operation that a network protocol should process.
<p> For a detailed description of the Qt Network Architecture
how to implement and use network protocols in Qt, see
the <a href="network.html">Qt Network Documentation</a>.
<p> <p>See also <a href="qnetworkprotocol.html">QNetworkProtocol</a> and <a href="io.html">Input/Output and Networking</a>.
<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="QNetworkOperation"></a>QNetworkOperation::QNetworkOperation ( <a href="qnetworkprotocol.html#Operation-enum">QNetworkProtocol::Operation</a> operation, const <a href="qstring.html">QString</a> & arg0, const <a href="qstring.html">QString</a> & arg1, const <a href="qstring.html">QString</a> & arg2 )
</h3>
Constructs a network operation object. <em>operation</em> is the type
of the operation, and <em>arg0</em>, <em>arg1</em> and <em>arg2</em> are the
first three arguments of the operation.
The state is initialized to QNetworkProtocol::StWaiting.
<p> <p>See also <a href="qnetworkprotocol.html#Operation-enum">QNetworkProtocol::Operation</a> and <a href="qnetworkprotocol.html#State-enum">QNetworkProtocol::State</a>.
<h3 class=fn><a name="QNetworkOperation-2"></a>QNetworkOperation::QNetworkOperation ( <a href="qnetworkprotocol.html#Operation-enum">QNetworkProtocol::Operation</a> operation, const <a href="qbytearray.html">QByteArray</a> & arg0, const <a href="qbytearray.html">QByteArray</a> & arg1, const <a href="qbytearray.html">QByteArray</a> & arg2 )
</h3>
Constructs a network operation object. <em>operation</em> is the type
of the operation, and <em>arg0</em>, <em>arg1</em> and <em>arg2</em> are the first three
raw data arguments of the operation.
The state is initialized to QNetworkProtocol::StWaiting.
<p> <p>See also <a href="qnetworkprotocol.html#Operation-enum">QNetworkProtocol::Operation</a> and <a href="qnetworkprotocol.html#State-enum">QNetworkProtocol::State</a>.
<h3 class=fn><a name="~QNetworkOperation"></a>QNetworkOperation::~QNetworkOperation ()
</h3>
Destructor.
<h3 class=fn><a href="qstring.html">QString</a> <a name="arg"></a>QNetworkOperation::arg ( int num ) const
</h3>
Returns the argument <em>num</em> of the operation. If this argument was
not already set, an empty string is returned.
<p>Examples: <a href="ftpclient-example.html#x1017">network/ftpclient/ftpmainwindow.cpp</a> and <a href="networkprotocol-example.html#x938">network/networkprotocol/nntp.cpp</a>.
<h3 class=fn>int <a name="errorCode"></a>QNetworkOperation::errorCode () const
</h3> Returns the error code for the last error that occurred.
<p>Example: <a href="ftpclient-example.html#x1018">network/ftpclient/ftpmainwindow.cpp</a>.
<h3 class=fn>void <a name="free"></a>QNetworkOperation::free ()
</h3>
Sets this object to delete itself when it hasn't been used for one second.
<p> Because QNetworkOperation pointers are passed around a lot the
<a href="qnetworkprotocol.html">QNetworkProtocol</a> generally does not have enough knowledge to delete
these at the correct time. If a QNetworkProtocol doesn't need an
operation any more it will call this function instead.
<p> Note: you should never need to call the method yourself.
<h3 class=fn><a href="qnetworkprotocol.html#Operation-enum">QNetworkProtocol::Operation</a> <a name="operation"></a>QNetworkOperation::operation () const
</h3>
Returns the type of the operation.
<p>Example: <a href="ftpclient-example.html#x1019">network/ftpclient/ftpmainwindow.cpp</a>.
<h3 class=fn><a href="qstring.html">QString</a> <a name="protocolDetail"></a>QNetworkOperation::protocolDetail () const
</h3> Returns a detailed error message for the last error. This must
have been set using <a href="#setProtocolDetail">setProtocolDetail</a>().
<p>Example: <a href="ftpclient-example.html#x1020">network/ftpclient/ftpmainwindow.cpp</a>.
<h3 class=fn><a href="qbytearray.html">QByteArray</a> <a name="rawArg"></a>QNetworkOperation::rawArg ( int num ) const
</h3>
Returns the raw data argument <em>num</em> of the operation. If this argument was
not already set, an empty bytearray is returned.
<h3 class=fn>void <a name="setArg"></a>QNetworkOperation::setArg ( int num, const <a href="qstring.html">QString</a> & arg )
</h3>
Sets the argument <em>num</em> of the network operation to <em>arg</em>.
<h3 class=fn>void <a name="setErrorCode"></a>QNetworkOperation::setErrorCode ( int ec )
</h3>
Sets the error code to <em>ec</em>.
<p> If the operation failed, the protocol should set an error code
to describe the error in more detail. If possible, one of the
error codes defined in <a href="qnetworkprotocol.html">QNetworkProtocol</a> should be used.
<p> <p>See also <a href="#setProtocolDetail">setProtocolDetail</a>() and <a href="qnetworkprotocol.html#Error-enum">QNetworkProtocol::Error</a>.
<h3 class=fn>void <a name="setProtocolDetail"></a>QNetworkOperation::setProtocolDetail ( const <a href="qstring.html">QString</a> & detail )
</h3>
If the operation failed, the error message can be specified as <em>detail</em>.
<h3 class=fn>void <a name="setRawArg"></a>QNetworkOperation::setRawArg ( int num, const <a href="qbytearray.html">QByteArray</a> & arg )
</h3>
Sets the raw data argument <em>num</em> of the network operation to <em>arg</em>.
<h3 class=fn>void <a name="setState"></a>QNetworkOperation::setState ( <a href="qnetworkprotocol.html#State-enum">QNetworkProtocol::State</a> state )
</h3>
Sets the <em>state</em> of the operation object. This should be done
by the network protocol during processing; at the end
it should be set to QNetworkProtocol::StDone or QNetworkProtocol::StFailed,
depending on success or failure.
<p> <p>See also <a href="qnetworkprotocol.html#State-enum">QNetworkProtocol::State</a>.
<h3 class=fn><a href="qnetworkprotocol.html#State-enum">QNetworkProtocol::State</a> <a name="state"></a>QNetworkOperation::state () const
</h3>
Returns the state of the operation. You can determine whether an
operation is still waiting to be processed, is being processed, has been
processed successfully, or failed.
<p>Example: <a href="ftpclient-example.html#x1021">network/ftpclient/ftpmainwindow.cpp</a>.
<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright © 1995-2001
<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 © 2001
<a href="http://www.trolltech.com">Trolltech</a><td><a href="http://www.trolltech.com/trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt version 3.0.2</div>
</table></div></address></body>
</html>
distrib
>
Mandriva
>
8.2
>
i586
>
media
>
contrib
>
by-pkgid
>
112b0974ad288f6cd55bf971ee6026a9
>
files
>
1577
