~oif-team/ubuntu/natty/qt4-x11/xi2.1

<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="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="top" width="230"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></td></tr></table><h1 align="center">Q3NetworkOperation Class Reference</h1>

<p>The Q3NetworkOperation class provides common operations for network protocols. <a href="#details">More...</a></p>

<pre>#include <Q3NetworkOperation></pre><p><b>This class is part of the Qt 3 support library.</b> It is provided to keep old source code working. We strongly advise against using it in new code. See the <a href="porting4.html">Porting Guide</a> for more information.</p>

<p>Part of the <a href="qt3support.html">Qt3Support</a> module.</p>

<p>Inherits <a href="qobject.html">QObject</a>.</p>

<ul>

<li><a href="q3networkoperation-members.html">List of all members, including inherited members</a></li>

</ul>

<h3>Public Functions</h3>

<ul>

<li><div class="fn"/><b><a href="q3networkoperation.html#Q3NetworkOperation">Q3NetworkOperation</a></b> ( Q3NetworkProtocol::Operation <i>operation</i>, const QString & <i>arg0</i>, const QString & <i>arg1</i>, const QString & <i>arg2</i> )</li>

<li><div class="fn"/><b><a href="q3networkoperation.html#Q3NetworkOperation-2">Q3NetworkOperation</a></b> ( Q3NetworkProtocol::Operation <i>operation</i>, const QByteArray & <i>arg0</i>, const QByteArray & <i>arg1</i>, const QByteArray & <i>arg2</i> )</li>

<li><div class="fn"/><b><a href="q3networkoperation.html#dtor.Q3NetworkOperation">~Q3NetworkOperation</a></b> ()</li>

<li><div class="fn"/>QString <b><a href="q3networkoperation.html#arg">arg</a></b> ( int <i>num</i> ) const</li>

<li><div class="fn"/>int <b><a href="q3networkoperation.html#errorCode">errorCode</a></b> () const</li>

<li><div class="fn"/>Q3NetworkProtocol::Operation <b><a href="q3networkoperation.html#operation">operation</a></b> () const</li>

<li><div class="fn"/>QString <b><a href="q3networkoperation.html#protocolDetail">protocolDetail</a></b> () const</li>

<li><div class="fn"/>QByteArray <b><a href="q3networkoperation.html#rawArg">rawArg</a></b> ( int <i>num</i> ) const</li>

<li><div class="fn"/>void <b><a href="q3networkoperation.html#setArg">setArg</a></b> ( int <i>num</i>, const QString & <i>arg</i> )</li>

<li><div class="fn"/>void <b><a href="q3networkoperation.html#setErrorCode">setErrorCode</a></b> ( int <i>ec</i> )</li>

<li><div class="fn"/>void <b><a href="q3networkoperation.html#setProtocolDetail">setProtocolDetail</a></b> ( const QString & <i>detail</i> )</li>

<li><div class="fn"/>void <b><a href="q3networkoperation.html#setRawArg">setRawArg</a></b> ( int <i>num</i>, const QByteArray & <i>arg</i> )</li>

<li><div class="fn"/>void <b><a href="q3networkoperation.html#setState">setState</a></b> ( Q3NetworkProtocol::State <i>state</i> )</li>

<li><div class="fn"/>Q3NetworkProtocol::State <b><a href="q3networkoperation.html#state">state</a></b> () const</li>

</ul>

<ul>

<li><div class="fn"/>28 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>

</ul>

<h3>Additional Inherited Members</h3>

<ul>

<li><div class="fn"/>1 property inherited from <a href="qobject.html#properties">QObject</a></li>

<li><div class="fn"/>1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>

<li><div class="fn"/>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>

<li><div class="fn"/>4 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>

<li><div class="fn"/>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>

</ul>

<hr />

<h2>Detailed Description</h2>

<p>The Q3NetworkOperation 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>

<p>See also <a href="q3networkprotocol.html">Q3NetworkProtocol</a>.</p>

<hr />

<h2>Member Function Documentation</h2>

<h3 class="fn"><a name="Q3NetworkOperation"></a>Q3NetworkOperation::Q3NetworkOperation ( <a href="q3networkprotocol.html#Operation-enum">Q3NetworkProtocol::Operation</a> <i>operation</i>, const <a href="qstring.html">QString</a> & <i>arg0</i>, const <a href="qstring.html">QString</a> & <i>arg1</i>, const <a href="qstring.html">QString</a> & <i>arg2</i> )</h3>

<p>Constructs a network operation object. <i>operation</i> is the type of the operation, and <i>arg0</i>, <i>arg1</i> and <i>arg2</i> are the first three arguments of the operation. The state is initialized to <a href="q3networkprotocol.html#State-enum">Q3NetworkProtocol::StWaiting</a>.</p>

<p>See also <a href="q3networkprotocol.html#Operation-enum">Q3NetworkProtocol::Operation</a> and <a href="q3networkprotocol.html#State-enum">Q3NetworkProtocol::State</a>.</p>

<h3 class="fn"><a name="Q3NetworkOperation-2"></a>Q3NetworkOperation::Q3NetworkOperation ( <a href="q3networkprotocol.html#Operation-enum">Q3NetworkProtocol::Operation</a> <i>operation</i>, const <a href="qbytearray.html">QByteArray</a> & <i>arg0</i>, const <a href="qbytearray.html">QByteArray</a> & <i>arg1</i>, const <a href="qbytearray.html">QByteArray</a> & <i>arg2</i> )</h3>

<p>Constructs a network operation object. <i>operation</i> is the type of the operation, and <i>arg0</i>, <i>arg1</i> and <i>arg2</i> are the first three raw data arguments of the operation. The state is initialized to <a href="q3networkprotocol.html#State-enum">Q3NetworkProtocol::StWaiting</a>.</p>

<p>See also <a href="q3networkprotocol.html#Operation-enum">Q3NetworkProtocol::Operation</a> and <a href="q3networkprotocol.html#State-enum">Q3NetworkProtocol::State</a>.</p>

<h3 class="fn"><a name="dtor.Q3NetworkOperation"></a>Q3NetworkOperation::~Q3NetworkOperation ()</h3>

<p>Destructor.</p>

<h3 class="fn"><a name="arg"></a><a href="qstring.html">QString</a> Q3NetworkOperation::arg ( int <i>num</i> ) const</h3>

<p>Returns the operation's <i>num</i>-th argument. If this argument was not already set, an empty string is returned.</p>

<h3 class="fn"><a name="errorCode"></a>int Q3NetworkOperation::errorCode () const</h3>

<p>Returns the error code for the last error that occurred.</p>

<h3 class="fn"><a name="free"></a>void Q3NetworkOperation::free ()</h3>

<p>Sets this object to delete itself when it hasn't been used for one second.</p>

<p>Because <a href="q3networkoperation.html">Q3NetworkOperation</a> pointers are passed around a lot the <a href="q3networkprotocol.html">Q3NetworkProtocol</a> generally does not have enough knowledge to delete these at the correct time. If a <a href="q3networkprotocol.html">Q3NetworkProtocol</a> doesn't need an operation any more it will call this function instead.</p>

<p>Note: you should never need to call the method yourself.</p>

<h3 class="fn"><a name="operation"></a><a href="q3networkprotocol.html#Operation-enum">Q3NetworkProtocol::Operation</a> Q3NetworkOperation::operation () const</h3>

<p>Returns the type of the operation.</p>

<h3 class="fn"><a name="protocolDetail"></a><a href="qstring.html">QString</a> Q3NetworkOperation::protocolDetail () const</h3>

<p>Returns a detailed error message for the last error. This must have been set using <a href="q3networkoperation.html#setProtocolDetail">setProtocolDetail</a>().</p>

<h3 class="fn"><a name="rawArg"></a><a href="qbytearray.html">QByteArray</a> Q3NetworkOperation::rawArg ( int <i>num</i> ) const</h3>

<p>Returns the operation's <i>num</i>-th raw data argument. If this argument was not already set, an empty bytearray is returned.</p>

<h3 class="fn"><a name="setArg"></a>void Q3NetworkOperation::setArg ( int <i>num</i>, const <a href="qstring.html">QString</a> & <i>arg</i> )</h3>

<p>Sets the network operation's <i>num</i>-th argument to <i>arg</i>.</p>

<h3 class="fn"><a name="setErrorCode"></a>void Q3NetworkOperation::setErrorCode ( int <i>ec</i> )</h3>

<p>Sets the error code to <i>ec</i>.</p>

<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="q3networkprotocol.html">Q3NetworkProtocol</a> should be used.</p>

<p>See also <a href="q3networkoperation.html#setProtocolDetail">setProtocolDetail</a>() and <a href="q3networkprotocol.html#Error-enum">Q3NetworkProtocol::Error</a>.</p>

<h3 class="fn"><a name="setProtocolDetail"></a>void Q3NetworkOperation::setProtocolDetail ( const <a href="qstring.html">QString</a> & <i>detail</i> )</h3>

<p>If the operation failed, the error message can be specified as <i>detail</i>.</p>

<h3 class="fn"><a name="setRawArg"></a>void Q3NetworkOperation::setRawArg ( int <i>num</i>, const <a href="qbytearray.html">QByteArray</a> & <i>arg</i> )</h3>

<p>Sets the network operation's <i>num</i>-th raw data argument to <i>arg</i>.</p>

<h3 class="fn"><a name="setState"></a>void Q3NetworkOperation::setState ( <a href="q3networkprotocol.html#State-enum">Q3NetworkProtocol::State</a> <i>state</i> )</h3>

<p>Sets the <i>state</i> of the operation object. This should be done by the network protocol during processing; at the end it should be set to <a href="q3networkprotocol.html#State-enum">Q3NetworkProtocol::StDone</a> or <a href="q3networkprotocol.html#State-enum">Q3NetworkProtocol::StFailed</a>, depending on success or failure.</p>

100

<p>See also <a href="q3networkprotocol.html#State-enum">Q3NetworkProtocol::State</a>.</p>

101

<h3 class="fn"><a name="state"></a><a href="q3networkprotocol.html#State-enum">Q3NetworkProtocol::State</a> Q3NetworkOperation::state () const</h3>

102

<p>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>

103

104

105

106

<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>

107

108

</tr></table></div></address></body>

109

</html>

Older »