<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- q3networkprotocol.cpp --> <title>Qt 4.8: Q3NetworkOperation Class Reference</title> <link rel="stylesheet" type="text/css" href="style/style.css" /> <script src="scripts/jquery.js" type="text/javascript"></script> <script src="scripts/functions.js" type="text/javascript"></script> <link rel="stylesheet" type="text/css" href="style/superfish.css" /> <link rel="stylesheet" type="text/css" href="style/narrow.css" /> <!--[if IE]> <meta name="MSSmartTagsPreventParsing" content="true"> <meta http-equiv="imagetoolbar" content="no"> <![endif]--> <!--[if lt IE 7]> <link rel="stylesheet" type="text/css" href="style/style_ie6.css"> <![endif]--> <!--[if IE 7]> <link rel="stylesheet" type="text/css" href="style/style_ie7.css"> <![endif]--> <!--[if IE 8]> <link rel="stylesheet" type="text/css" href="style/style_ie8.css"> <![endif]--> <script src="scripts/superfish.js" type="text/javascript"></script> <script src="scripts/narrow.js" type="text/javascript"></script> </head> <body class="" onload="CheckEmptyAndLoadList();"> <div class="header" id="qtdocheader"> <div class="content"> <div id="nav-logo"> <a href="index.html">Home</a></div> <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a> <div id="narrowsearch"></div> <div id="nav-topright"> <ul> <li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li> <li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li> <li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/"> DOC</a></li> <li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li> </ul> </div> <div id="shortCut"> <ul> <li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li> <li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li> </ul> </div> <ul class="sf-menu" id="narrowmenu"> <li><a href="#">API Lookup</a> <ul> <li><a href="classes.html">Class index</a></li> <li><a href="functions.html">Function index</a></li> <li><a href="modules.html">Modules</a></li> <li><a href="namespaces.html">Namespaces</a></li> <li><a href="qtglobal.html">Global Declarations</a></li> <li><a href="qdeclarativeelements.html">QML elements</a></li> </ul> </li> <li><a href="#">Qt Topics</a> <ul> <li><a href="qt-basic-concepts.html">Programming with Qt</a></li> <li><a href="qtquick.html">Device UIs & Qt Quick</a></li> <li><a href="qt-gui-concepts.html">UI Design with Qt</a></li> <li><a href="supported-platforms.html">Supported Platforms</a></li> <li><a href="technology-apis.html">Qt and Key Technologies</a></li> <li><a href="best-practices.html">How-To's and Best Practices</a></li> </ul> </li> <li><a href="#">Examples</a> <ul> <li><a href="all-examples.html">Examples</a></li> <li><a href="tutorials.html">Tutorials</a></li> <li><a href="demos.html">Demos</a></li> <li><a href="qdeclarativeexamples.html">QML Examples</a></li> </ul> </li> </ul> </div> </div> <div class="wrapper"> <div class="hd"> <span></span> </div> <div class="bd group"> <div class="sidebar"> <div class="searchlabel"> Search index:</div> <div class="search" id="sidebarsearch"> <form id="qtdocsearch" action="" onsubmit="return false;"> <fieldset> <input type="text" name="searchstring" id="pageType" value="" /> <div id="resultdialog"> <a href="#" id="resultclose">Close</a> <p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p> <p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p> <ul id="resultlist" class="all"> </ul> </div> </fieldset> </form> </div> <div class="box first bottombar" id="lookup"> <h2 title="API Lookup"><span></span> API Lookup</h2> <div id="list001" class="list"> <ul id="ul001" > <li class="defaultLink"><a href="classes.html">Class index</a></li> <li class="defaultLink"><a href="functions.html">Function index</a></li> <li class="defaultLink"><a href="modules.html">Modules</a></li> <li class="defaultLink"><a href="namespaces.html">Namespaces</a></li> <li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li> <li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li> </ul> </div> </div> <div class="box bottombar" id="topics"> <h2 title="Qt Topics"><span></span> Qt Topics</h2> <div id="list002" class="list"> <ul id="ul002" > <li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li> <li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li> <li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li> <li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li> <li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li> <li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li> </ul> </div> </div> <div class="box" id="examples"> <h2 title="Examples"><span></span> Examples</h2> <div id="list003" class="list"> <ul id="ul003"> <li class="defaultLink"><a href="all-examples.html">Examples</a></li> <li class="defaultLink"><a href="tutorials.html">Tutorials</a></li> <li class="defaultLink"><a href="demos.html">Demos</a></li> <li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li> </ul> </div> </div> </div> <div class="wrap"> <div class="toolbar"> <div class="breadcrumb toolblock"> <ul> <li class="first"><a href="index.html">Home</a></li> <!-- Breadcrumbs go here --> <li><a href="modules.html">Modules</a></li> <li>Qt3SupportLight</li> <li>Q3NetworkOperation</li> </ul> </div> <div class="toolbuttons toolblock"> <ul> <li id="smallA" class="t_button">A</li> <li id="medA" class="t_button active">A</li> <li id="bigA" class="t_button">A</li> <li id="print" class="t_button"><a href="javascript:this.print();"> <span>Print</span></a></li> </ul> </div> </div> <div class="content mainContent"> <div class="toc"> <h3><a name="toc">Contents</a></h3> <ul> <li class="level1"><a href="#public-functions">Public Functions</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> </div> <h1 class="title">Q3NetworkOperation Class Reference</h1> <!-- $$$Q3NetworkOperation-brief --> <p>The Q3NetworkOperation class provides common operations for network protocols. <a href="#details">More...</a></p> <!-- @@@Q3NetworkOperation --> <pre class="cpp"> <span class="preprocessor">#include <Q3NetworkOperation></span></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 <a href="porting4.html">Porting to Qt 4</a> for more information.</p> <p><b>Inherits: </b><a href="qobject.html">QObject</a>.</p> <ul> <li><a href="q3networkoperation-members.html">List of all members, including inherited members</a></li> </ul> <a name="public-functions"></a> <h2>Public Functions</h2> <table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><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> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><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> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3networkoperation.html#dtor.Q3NetworkOperation">~Q3NetworkOperation</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="q3networkoperation.html#arg">arg</a></b> ( int <i>num</i> ) const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="q3networkoperation.html#errorCode">errorCode</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3networkoperation.html#free">free</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Q3NetworkProtocol::Operation </td><td class="memItemRight bottomAlign"><b><a href="q3networkoperation.html#operation">operation</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="q3networkoperation.html#protocolDetail">protocolDetail</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QByteArray </td><td class="memItemRight bottomAlign"><b><a href="q3networkoperation.html#rawArg">rawArg</a></b> ( int <i>num</i> ) const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3networkoperation.html#setArg">setArg</a></b> ( int <i>num</i>, const QString & <i>arg</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3networkoperation.html#setErrorCode">setErrorCode</a></b> ( int <i>ec</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3networkoperation.html#setProtocolDetail">setProtocolDetail</a></b> ( const QString & <i>detail</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3networkoperation.html#setRawArg">setRawArg</a></b> ( int <i>num</i>, const QByteArray & <i>arg</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3networkoperation.html#setState">setState</a></b> ( Q3NetworkProtocol::State <i>state</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Q3NetworkProtocol::State </td><td class="memItemRight bottomAlign"><b><a href="q3networkoperation.html#state">state</a></b> () const</td></tr> </table> <ul> <li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li> </ul> <h3>Additional Inherited Members</h3> <ul> <li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</a></li> <li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li> <li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li> <li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li> <li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li> </ul> <a name="details"></a> <!-- $$$Q3NetworkOperation-description --> <div class="descr"> <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> </div> <p><b>See also </b><a href="q3networkprotocol.html">Q3NetworkProtocol</a>.</p> <!-- @@@Q3NetworkOperation --> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$Q3NetworkOperation[overload1]$$$Q3NetworkOperationQ3NetworkProtocol::OperationconstQString&constQString&constQString& --> <h3 class="fn"><a name="Q3NetworkOperation"></a>Q3NetworkOperation::<span class="name">Q3NetworkOperation</span> ( <span class="type"><a href="q3networkprotocol.html#Operation-enum">Q3NetworkProtocol::Operation</a></span> <i>operation</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>arg0</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>arg1</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <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><b>See also </b><a href="q3networkprotocol.html#Operation-enum">Q3NetworkProtocol::Operation</a> and <a href="q3networkprotocol.html#State-enum">Q3NetworkProtocol::State</a>.</p> <!-- @@@Q3NetworkOperation --> <!-- $$$Q3NetworkOperation$$$Q3NetworkOperationQ3NetworkProtocol::OperationconstQByteArray&constQByteArray&constQByteArray& --> <h3 class="fn"><a name="Q3NetworkOperation-2"></a>Q3NetworkOperation::<span class="name">Q3NetworkOperation</span> ( <span class="type"><a href="q3networkprotocol.html#Operation-enum">Q3NetworkProtocol::Operation</a></span> <i>operation</i>, const <span class="type"><a href="qbytearray.html">QByteArray</a></span> & <i>arg0</i>, const <span class="type"><a href="qbytearray.html">QByteArray</a></span> & <i>arg1</i>, const <span class="type"><a href="qbytearray.html">QByteArray</a></span> & <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><b>See also </b><a href="q3networkprotocol.html#Operation-enum">Q3NetworkProtocol::Operation</a> and <a href="q3networkprotocol.html#State-enum">Q3NetworkProtocol::State</a>.</p> <!-- @@@Q3NetworkOperation --> <!-- $$$~Q3NetworkOperation[overload1]$$$~Q3NetworkOperation --> <h3 class="fn"><a name="dtor.Q3NetworkOperation"></a>Q3NetworkOperation::<span class="name">~Q3NetworkOperation</span> ()</h3> <p>Destructor.</p> <!-- @@@~Q3NetworkOperation --> <!-- $$$arg[overload1]$$$argint --> <h3 class="fn"><a name="arg"></a><span class="type"><a href="qstring.html">QString</a></span> Q3NetworkOperation::<span class="name">arg</span> ( <span class="type">int</span> <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> <p><b>See also </b><a href="q3networkoperation.html#setArg">setArg</a>().</p> <!-- @@@arg --> <!-- $$$errorCode[overload1]$$$errorCode --> <h3 class="fn"><a name="errorCode"></a><span class="type">int</span> Q3NetworkOperation::<span class="name">errorCode</span> () const</h3> <p>Returns the error code for the last error that occurred.</p> <p><b>See also </b><a href="q3networkoperation.html#setErrorCode">setErrorCode</a>().</p> <!-- @@@errorCode --> <!-- $$$free[overload1]$$$free --> <h3 class="fn"><a name="free"></a><span class="type">void</span> Q3NetworkOperation::<span class="name">free</span> ()</h3> <p>Sets this object to delete itself when it hasn't been used for one second.</p> <p>Because <a href="q3networkoperation.html" class="compat">Q3NetworkOperation</a> pointers are passed around a lot the <a href="q3networkprotocol.html" class="compat">Q3NetworkProtocol</a> generally does not have enough knowledge to delete these at the correct time. If a <a href="q3networkprotocol.html" class="compat">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> <!-- @@@free --> <!-- $$$operation[overload1]$$$operation --> <h3 class="fn"><a name="operation"></a><span class="type"><a href="q3networkprotocol.html#Operation-enum">Q3NetworkProtocol::Operation</a></span> Q3NetworkOperation::<span class="name">operation</span> () const</h3> <p>Returns the type of the operation.</p> <!-- @@@operation --> <!-- $$$protocolDetail[overload1]$$$protocolDetail --> <h3 class="fn"><a name="protocolDetail"></a><span class="type"><a href="qstring.html">QString</a></span> Q3NetworkOperation::<span class="name">protocolDetail</span> () 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> <p><b>See also </b><a href="q3networkoperation.html#setProtocolDetail">setProtocolDetail</a>().</p> <!-- @@@protocolDetail --> <!-- $$$rawArg[overload1]$$$rawArgint --> <h3 class="fn"><a name="rawArg"></a><span class="type"><a href="qbytearray.html">QByteArray</a></span> Q3NetworkOperation::<span class="name">rawArg</span> ( <span class="type">int</span> <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> <p><b>See also </b><a href="q3networkoperation.html#setRawArg">setRawArg</a>().</p> <!-- @@@rawArg --> <!-- $$$setArg[overload1]$$$setArgintconstQString& --> <h3 class="fn"><a name="setArg"></a><span class="type">void</span> Q3NetworkOperation::<span class="name">setArg</span> ( <span class="type">int</span> <i>num</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>arg</i> )</h3> <p>Sets the network operation's <i>num</i>-th argument to <i>arg</i>.</p> <p><b>See also </b><a href="q3networkoperation.html#arg">arg</a>().</p> <!-- @@@setArg --> <!-- $$$setErrorCode[overload1]$$$setErrorCodeint --> <h3 class="fn"><a name="setErrorCode"></a><span class="type">void</span> Q3NetworkOperation::<span class="name">setErrorCode</span> ( <span class="type">int</span> <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" class="compat">Q3NetworkProtocol</a> should be used.</p> <p><b>See also </b><a href="q3networkoperation.html#errorCode">errorCode</a>(), <a href="q3networkoperation.html#setProtocolDetail">setProtocolDetail</a>(), and <a href="q3networkprotocol.html#Error-enum">Q3NetworkProtocol::Error</a>.</p> <!-- @@@setErrorCode --> <!-- $$$setProtocolDetail[overload1]$$$setProtocolDetailconstQString& --> <h3 class="fn"><a name="setProtocolDetail"></a><span class="type">void</span> Q3NetworkOperation::<span class="name">setProtocolDetail</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>detail</i> )</h3> <p>If the operation failed, the error message can be specified as <i>detail</i>.</p> <p><b>See also </b><a href="q3networkoperation.html#protocolDetail">protocolDetail</a>().</p> <!-- @@@setProtocolDetail --> <!-- $$$setRawArg[overload1]$$$setRawArgintconstQByteArray& --> <h3 class="fn"><a name="setRawArg"></a><span class="type">void</span> Q3NetworkOperation::<span class="name">setRawArg</span> ( <span class="type">int</span> <i>num</i>, const <span class="type"><a href="qbytearray.html">QByteArray</a></span> & <i>arg</i> )</h3> <p>Sets the network operation's <i>num</i>-th raw data argument to <i>arg</i>.</p> <p><b>See also </b><a href="q3networkoperation.html#rawArg">rawArg</a>().</p> <!-- @@@setRawArg --> <!-- $$$setState[overload1]$$$setStateQ3NetworkProtocol::State --> <h3 class="fn"><a name="setState"></a><span class="type">void</span> Q3NetworkOperation::<span class="name">setState</span> ( <span class="type"><a href="q3networkprotocol.html#State-enum">Q3NetworkProtocol::State</a></span> <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> <p><b>See also </b><a href="q3networkoperation.html#state">state</a>() and <a href="q3networkprotocol.html#State-enum">Q3NetworkProtocol::State</a>.</p> <!-- @@@setState --> <!-- $$$state[overload1]$$$state --> <h3 class="fn"><a name="state"></a><span class="type"><a href="q3networkprotocol.html#State-enum">Q3NetworkProtocol::State</a></span> Q3NetworkOperation::<span class="name">state</span> () const</h3> <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> <p><b>See also </b><a href="q3networkoperation.html#setState">setState</a>().</p> <!-- @@@state --> </div> </div> </div> </div> <div class="ft"> <span></span> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners.</p> <br /> <p> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.</p> <p> Documentation sources may be obtained from <a href="http://www.qt-project.org"> www.qt-project.org</a>.</p> <br /> <p> Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners. <a title="Privacy Policy" href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p> </div> <script src="scripts/functions.js" type="text/javascript"></script> </body> </html>