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.
170 lines
9.8 KiB
170 lines
9.8 KiB
13 years ago
|
<!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/kernel/qnetworkprotocol.cpp:974 -->
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||
|
|
<title>TQNetworkOperation 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 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>TQNetworkOperation Class Reference<br><small>[<a href="network.html">network module</a>]</small></h1>
|
||
|
|
|
||
|
|
<p>The TQNetworkOperation 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">TQObject</a>.
|
||
|
|
<p><a href="qnetworkoperation-members.html">List of all member functions.</a>
|
||
|
|
<h2>Public Members</h2>
|
||
|
|
<ul>
|
||
|
|
<li class=fn><a href="#TQNetworkOperation"><b>TQNetworkOperation</b></a> ( TQNetworkProtocol::Operation operation, const TQString & arg0, const TQString & arg1, const TQString & arg2 )</li>
|
||
|
|
<li class=fn><a href="#TQNetworkOperation-2"><b>TQNetworkOperation</b></a> ( TQNetworkProtocol::Operation operation, const TQByteArray & arg0, const TQByteArray & arg1, const TQByteArray & arg2 )</li>
|
||
|
|
<li class=fn><a href="#~TQNetworkOperation"><b>~TQNetworkOperation</b></a> ()</li>
|
||
|
|
<li class=fn>void <a href="#setState"><b>setState</b></a> ( TQNetworkProtocol::State state )</li>
|
||
|
|
<li class=fn>void <a href="#setProtocolDetail"><b>setProtocolDetail</b></a> ( const TQString & detail )</li>
|
||
|
|
<li class=fn>void <a href="#setErrorCode"><b>setErrorCode</b></a> ( int ec )</li>
|
||
|
|
<li class=fn>void <a href="#setArg"><b>setArg</b></a> ( int num, const TQString & arg )</li>
|
||
|
|
<li class=fn>void <a href="#setRawArg"><b>setRawArg</b></a> ( int num, const TQByteArray & arg )</li>
|
||
|
|
<li class=fn>TQNetworkProtocol::Operation <a href="#operation"><b>operation</b></a> () const</li>
|
||
|
|
<li class=fn>TQNetworkProtocol::State <a href="#state"><b>state</b></a> () const</li>
|
||
|
|
<li class=fn>TQString <a href="#arg"><b>arg</b></a> ( int num ) const</li>
|
||
|
|
<li class=fn>TQByteArray <a href="#rawArg"><b>rawArg</b></a> ( int num ) const</li>
|
||
|
|
<li class=fn>TQString <a href="#protocolDetail"><b>protocolDetail</b></a> () const</li>
|
||
|
|
<li class=fn>int <a href="#errorCode"><b>errorCode</b></a> () const</li>
|
||
|
|
<li class=fn>void <a href="#free"><b>free</b></a> ()</li>
|
||
|
|
</ul>
|
||
|
|
<hr><a name="details"></a><h2>Detailed Description</h2>
|
||
|
|
|
||
|
|
|
||
|
|
<p> The TQNetworkOperation 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 TQt Network Architecture and how
|
||
|
|
to implement and use network protocols in TQt, see the <a href="network.html">TQt Network Documentation</a>.
|
||
|
|
<p> <p>See also <a href="qnetworkprotocol.html">TQNetworkProtocol</a> and <a href="io.html">Input/Output and Networking</a>.
|
||
|
|
|
||
|
|
<hr><h2>Member Function Documentation</h2>
|
||
|
|
<h3 class=fn><a name="TQNetworkOperation"></a>TQNetworkOperation::TQNetworkOperation ( <a href="qnetworkprotocol.html#Operation-enum">TQNetworkProtocol::Operation</a> operation, const <a href="qstring.html">TQString</a> & arg0, const <a href="qstring.html">TQString</a> & arg1, const <a href="qstring.html">TQString</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
|
||
|
|
TQNetworkProtocol::StWaiting.
|
||
|
|
<p> <p>See also <a href="qnetworkprotocol.html#Operation-enum">TQNetworkProtocol::Operation</a> and <a href="qnetworkprotocol.html#State-enum">TQNetworkProtocol::State</a>.
|
||
|
|
|
||
|
|
<h3 class=fn><a name="TQNetworkOperation-2"></a>TQNetworkOperation::TQNetworkOperation ( <a href="qnetworkprotocol.html#Operation-enum">TQNetworkProtocol::Operation</a> operation, const <a href="qbytearray.html">TQByteArray</a> & arg0, const <a href="qbytearray.html">TQByteArray</a> & arg1, const <a href="qbytearray.html">TQByteArray</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 TQNetworkProtocol::StWaiting.
|
||
|
|
<p> <p>See also <a href="qnetworkprotocol.html#Operation-enum">TQNetworkProtocol::Operation</a> and <a href="qnetworkprotocol.html#State-enum">TQNetworkProtocol::State</a>.
|
||
|
|
|
||
|
|
<h3 class=fn><a name="~TQNetworkOperation"></a>TQNetworkOperation::~TQNetworkOperation ()
|
||
|
|
</h3>
|
||
|
|
Destructor.
|
||
|
|
|
||
|
|
<h3 class=fn><a href="qstring.html">TQString</a> <a name="arg"></a>TQNetworkOperation::arg ( int num ) const
|
||
|
|
</h3>
|
||
|
|
Returns the operation's <em>num</em>-th argument. If this argument was
|
||
|
|
not already set, an empty string is returned.
|
||
|
|
|
||
|
|
<p>Example: <a href="networkprotocol-example.html#x672">network/networkprotocol/nntp.cpp</a>.
|
||
|
|
<h3 class=fn>int <a name="errorCode"></a>TQNetworkOperation::errorCode () const
|
||
|
|
</h3>
|
||
|
|
Returns the error code for the last error that occurred.
|
||
|
|
|
||
|
|
<h3 class=fn>void <a name="free"></a>TQNetworkOperation::free ()
|
||
|
|
</h3>
|
||
|
|
Sets this object to delete itself when it hasn't been used for one
|
||
|
|
second.
|
||
|
|
<p> Because TQNetworkOperation pointers are passed around a lot the
|
||
|
|
<a href="qnetworkprotocol.html">TQNetworkProtocol</a> generally does not have enough knowledge to
|
||
|
|
delete these at the correct time. If a TQNetworkProtocol 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">TQNetworkProtocol::Operation</a> <a name="operation"></a>TQNetworkOperation::operation () const
|
||
|
|
</h3>
|
||
|
|
Returns the type of the operation.
|
||
|
|
|
||
|
|
<h3 class=fn><a href="qstring.html">TQString</a> <a name="protocolDetail"></a>TQNetworkOperation::protocolDetail () const
|
||
|
|
</h3>
|
||
|
|
Returns a detailed error message for the last error. This must
|
||
|
|
have been set using <a href="#setProtocolDetail">setProtocolDetail</a>().
|
||
|
|
|
||
|
|
<h3 class=fn><a href="qbytearray.html">TQByteArray</a> <a name="rawArg"></a>TQNetworkOperation::rawArg ( int num ) const
|
||
|
|
</h3>
|
||
|
|
Returns the operation's <em>num</em>-th raw data argument. If this
|
||
|
|
argument was not already set, an empty bytearray is returned.
|
||
|
|
|
||
|
|
<h3 class=fn>void <a name="setArg"></a>TQNetworkOperation::setArg ( int num, const <a href="qstring.html">TQString</a> & arg )
|
||
|
|
</h3>
|
||
|
|
Sets the network operation's <em>num</em>-th argument to <em>arg</em>.
|
||
|
|
|
||
|
|
<h3 class=fn>void <a name="setErrorCode"></a>TQNetworkOperation::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">TQNetworkProtocol</a> should be used.
|
||
|
|
<p> <p>See also <a href="#setProtocolDetail">setProtocolDetail</a>() and <a href="qnetworkprotocol.html#Error-enum">TQNetworkProtocol::Error</a>.
|
||
|
|
|
||
|
|
<h3 class=fn>void <a name="setProtocolDetail"></a>TQNetworkOperation::setProtocolDetail ( const <a href="qstring.html">TQString</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>TQNetworkOperation::setRawArg ( int num, const <a href="qbytearray.html">TQByteArray</a> & arg )
|
||
|
|
</h3>
|
||
|
|
Sets the network operation's <em>num</em>-th raw data argument to <em>arg</em>.
|
||
|
|
|
||
|
|
<h3 class=fn>void <a name="setState"></a>TQNetworkOperation::setState ( <a href="qnetworkprotocol.html#State-enum">TQNetworkProtocol::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 TQNetworkProtocol::StDone or TQNetworkProtocol::StFailed,
|
||
|
|
depending on success or failure.
|
||
|
|
<p> <p>See also <a href="qnetworkprotocol.html#State-enum">TQNetworkProtocol::State</a>.
|
||
|
|
|
||
|
|
<h3 class=fn><a href="qnetworkprotocol.html#State-enum">TQNetworkProtocol::State</a> <a name="state"></a>TQNetworkOperation::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.
|
||
|
|
|
||
|
|
<!-- eof -->
|
||
|
|
<hr><p>
|
||
|
|
This file is part of the <a href="index.html">TQt toolkit</a>.
|
||
|
|
Copyright © 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 © 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>
|