diff options
| author | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2011-11-08 12:31:36 -0600 |
|---|---|---|
| committer | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2011-11-08 12:31:36 -0600 |
| commit | d796c9dd933ab96ec83b9a634feedd5d32e1ba3f (patch) | |
| tree | 6e3dcca4f77e20ec8966c666aac7c35bd4704053 /doc/html/qnetworkprotocol.html | |
| download | tqt3-d796c9dd933ab96ec83b9a634feedd5d32e1ba3f.tar.gz tqt3-d796c9dd933ab96ec83b9a634feedd5d32e1ba3f.zip | |
Test conversion to TQt3 from Qt3 8c6fc1f8e35fd264dd01c582ca5e7549b32ab731
Diffstat (limited to 'doc/html/qnetworkprotocol.html')
| -rw-r--r-- | doc/html/qnetworkprotocol.html | 532 |
1 files changed, 532 insertions, 0 deletions
diff --git a/doc/html/qnetworkprotocol.html b/doc/html/qnetworkprotocol.html new file mode 100644 index 000000000..6aac280c3 --- /dev/null +++ b/doc/html/qnetworkprotocol.html @@ -0,0 +1,532 @@ +<!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:98 --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>TQNetworkProtocol 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>TQNetworkProtocol Class Reference<br><small>[<a href="network.html">network module</a>]</small></h1> + +<p>The TQNetworkProtocol class provides a common API 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>Inherited by <a href="qftp.html">TQFtp</a>, <a href="qhttp.html">TQHttp</a>, and <a href="qlocalfs.html">TQLocalFs</a>. +<p><a href="qnetworkprotocol-members.html">List of all member functions.</a> +<h2>Public Members</h2> +<ul> +<li class=fn>enum <a href="#State-enum"><b>State</b></a> { StWaiting = 0, StInProgress, StDone, StFailed, StStopped }</li> +<li class=fn>enum <a href="#Operation-enum"><b>Operation</b></a> { OpListChildren = 1, OpMkDir = 2, OpMkdir = OpMkDir, OpRemove = 4, OpRename = 8, OpGet = 32, OpPut = 64 }</li> +<li class=fn>enum <a href="#ConnectionState-enum"><b>ConnectionState</b></a> { ConHostFound, ConConnected, ConClosed }</li> +<li class=fn>enum <a href="#Error-enum"><b>Error</b></a> { NoError = 0, ErrValid, ErrUnknownProtocol, ErrUnsupported, ErrParse, ErrLoginIncorrect, ErrHostNotFound, ErrListChildren, ErrListChlidren = ErrListChildren, ErrMkDir, ErrMkdir = ErrMkDir, ErrRemove, ErrRename, ErrGet, ErrPut, ErrFileNotExisting, ErrPermissionDenied }</li> +<li class=fn><a href="#TQNetworkProtocol"><b>TQNetworkProtocol</b></a> ()</li> +<li class=fn>virtual <a href="#~TQNetworkProtocol"><b>~TQNetworkProtocol</b></a> ()</li> +<li class=fn>virtual void <a href="#setUrl"><b>setUrl</b></a> ( TQUrlOperator * u )</li> +<li class=fn>virtual void <a href="#setAutoDelete"><b>setAutoDelete</b></a> ( bool b, int i = 10000 )</li> +<li class=fn>bool <a href="#autoDelete"><b>autoDelete</b></a> () const</li> +<li class=fn>virtual int <a href="#supportedOperations"><b>supportedOperations</b></a> () const</li> +<li class=fn>virtual void <a href="#addOperation"><b>addOperation</b></a> ( TQNetworkOperation * op )</li> +<li class=fn>TQUrlOperator * <a href="#url"><b>url</b></a> () const</li> +<li class=fn>TQNetworkOperation * <a href="#operationInProgress"><b>operationInProgress</b></a> () const</li> +<li class=fn>virtual void <a href="#clearOperationQueue"><b>clearOperationQueue</b></a> ()</li> +<li class=fn>virtual void <a href="#stop"><b>stop</b></a> ()</li> +</ul> +<h2>Signals</h2> +<ul> +<li class=fn>void <a href="#data"><b>data</b></a> ( const TQByteArray & data, TQNetworkOperation * op )</li> +<li class=fn>void <a href="#connectionStateChanged"><b>connectionStateChanged</b></a> ( int state, const TQString & data )</li> +<li class=fn>void <a href="#finished"><b>finished</b></a> ( TQNetworkOperation * op )</li> +<li class=fn>void <a href="#start"><b>start</b></a> ( TQNetworkOperation * op )</li> +<li class=fn>void <a href="#newChildren"><b>newChildren</b></a> ( const TQValueList<TQUrlInfo> & i, TQNetworkOperation * op )</li> +<li class=fn>void <a href="#newChild"><b>newChild</b></a> ( const TQUrlInfo & i, TQNetworkOperation * op )</li> +<li class=fn>void <a href="#createdDirectory"><b>createdDirectory</b></a> ( const TQUrlInfo & i, TQNetworkOperation * op )</li> +<li class=fn>void <a href="#removed"><b>removed</b></a> ( TQNetworkOperation * op )</li> +<li class=fn>void <a href="#itemChanged"><b>itemChanged</b></a> ( TQNetworkOperation * op )</li> +<li class=fn>void <a href="#dataTransferProgress"><b>dataTransferProgress</b></a> ( int bytesDone, int bytesTotal, TQNetworkOperation * op )</li> +</ul> +<h2>Static Public Members</h2> +<ul> +<li class=fn>void <a href="#registerNetworkProtocol"><b>registerNetworkProtocol</b></a> ( const TQString & protocol, TQNetworkProtocolFactoryBase * protocolFactory )</li> +<li class=fn>TQNetworkProtocol * <a href="#getNetworkProtocol"><b>getNetworkProtocol</b></a> ( const TQString & protocol )</li> +<li class=fn>bool <a href="#hasOnlyLocalFileSystem"><b>hasOnlyLocalFileSystem</b></a> ()</li> +</ul> +<h2>Protected Members</h2> +<ul> +<li class=fn>virtual void <a href="#operationListChildren"><b>operationListChildren</b></a> ( TQNetworkOperation * op )</li> +<li class=fn>virtual void <a href="#operationMkDir"><b>operationMkDir</b></a> ( TQNetworkOperation * op )</li> +<li class=fn>virtual void <a href="#operationRemove"><b>operationRemove</b></a> ( TQNetworkOperation * op )</li> +<li class=fn>virtual void <a href="#operationRename"><b>operationRename</b></a> ( TQNetworkOperation * op )</li> +<li class=fn>virtual void <a href="#operationGet"><b>operationGet</b></a> ( TQNetworkOperation * op )</li> +<li class=fn>virtual void <a href="#operationPut"><b>operationPut</b></a> ( TQNetworkOperation * op )</li> +<li class=fn>virtual bool <a href="#checkConnection"><b>checkConnection</b></a> ( TQNetworkOperation * op )</li> +</ul> +<hr><a name="details"></a><h2>Detailed Description</h2> + + +The TQNetworkProtocol class provides a common API for network protocols. + +<p> + + + +<p> This is a base class which should be used for network protocols +implementations that can then be used in TQt (e.g. in the file +dialog) together with the <a href="qurloperator.html">TQUrlOperator</a>. +<p> The easiest way to implement a new network protocol is to +reimplement the operation*() methods, e.g. <a href="#operationGet">operationGet</a>(), etc. +Only the supported operations should be reimplemented. To specify +which operations are supported, also reimplement +<a href="#supportedOperations">supportedOperations</a>() and return an int that is OR'd together +using the supported operations from the <a href="#Operation-enum">TQNetworkProtocol::Operation</a> enum. +<p> When you implement a network protocol this way, it is important to +emit the correct signals. Also, always emit the <a href="#finished">finished</a>() signal +when an operation is done (on success <em>and</em> on failure). TQt +relies on correctly emitted finished() signals. +<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>See also <a href="io.html">Input/Output and Networking</a>. + +<hr><h2>Member Type Documentation</h2> +<h3 class=fn><a name="ConnectionState-enum"></a>TQNetworkProtocol::ConnectionState</h3> + +<p> When the connection state of a network protocol changes it emits +the signal <a href="#connectionStateChanged">connectionStateChanged</a>(). The first argument is one of +the following values: +<ul> +<li><tt>TQNetworkProtocol::ConHostFound</tt> - Host has been found. +<li><tt>TQNetworkProtocol::ConConnected</tt> - Connection to the host has been established. +<li><tt>TQNetworkProtocol::ConClosed</tt> - Connection has been closed. +</ul> +<h3 class=fn><a name="Error-enum"></a>TQNetworkProtocol::Error</h3> + +<p> When an operation fails (finishes unsuccessfully), the +<a href="qnetworkoperation.html">TQNetworkOperation</a> of the operation returns an error code which has +one of the following values: +<ul> +<li><tt>TQNetworkProtocol::NoError</tt> - No error occurred. +<li><tt>TQNetworkProtocol::ErrValid</tt> - The URL you are operating on is not valid. +<li><tt>TQNetworkProtocol::ErrUnknownProtocol</tt> - There is no protocol implementation +available for the protocol of the URL you are operating on (e.g. +if the protocol is http and no http implementation has been +registered). +<li><tt>TQNetworkProtocol::ErrUnsupported</tt> - The operation is not supported by the +protocol. +<li><tt>TQNetworkProtocol::ErrParse</tt> - The URL could not be parsed correctly. +<li><tt>TQNetworkProtocol::ErrLoginIncorrect</tt> - You needed to login but the username +or password is wrong. +<li><tt>TQNetworkProtocol::ErrHostNotFound</tt> - The specified host (in the URL) couldn't +be found. +<li><tt>TQNetworkProtocol::ErrListChildren</tt> - An error occurred while listing the +children (files). +<li><tt>TQNetworkProtocol::ErrMkDir</tt> - An error occurred when creating a directory. +<li><tt>TQNetworkProtocol::ErrRemove</tt> - An error occurred when removing a child (file). +<li><tt>TQNetworkProtocol::ErrRename</tt> - An error occurred when renaming a child (file). +<li><tt>TQNetworkProtocol::ErrGet</tt> - An error occurred while getting (retrieving) data. +<li><tt>TQNetworkProtocol::ErrPut</tt> - An error occurred while putting (uploading) data. +<li><tt>TQNetworkProtocol::ErrFileNotExisting</tt> - A file which is needed by the operation +doesn't exist. +<li><tt>TQNetworkProtocol::ErrPermissionDenied</tt> - Permission for doing the operation has +been denied. +</ul><p> You should also use these error codes when implementing custom +network protocols. If this is not possible, you can define your own +error codes by using integer values that don't conflict with any +of these values. + +<h3 class=fn><a name="Operation-enum"></a>TQNetworkProtocol::Operation</h3> + +<p> This enum lists the possible operations that a network protocol +can support. <a href="#supportedOperations">supportedOperations</a>() returns an int of these that is +OR'd together. Also, the type() of a <a href="qnetworkoperation.html">TQNetworkOperation</a> is always +one of these values. +<ul> +<li><tt>TQNetworkProtocol::OpListChildren</tt> - List the children of a URL, e.g. of a directory. +<li><tt>TQNetworkProtocol::OpMkDir</tt> - Create a directory. +<li><tt>TQNetworkProtocol::OpRemove</tt> - Remove a child (e.g. a file). +<li><tt>TQNetworkProtocol::OpRename</tt> - Rename a child (e.g. a file). +<li><tt>TQNetworkProtocol::OpGet</tt> - Get data from a location. +<li><tt>TQNetworkProtocol::OpPut</tt> - Put data to a location. +</ul> +<h3 class=fn><a name="State-enum"></a>TQNetworkProtocol::State</h3> + +<p> This enum contains the state that a <a href="qnetworkoperation.html">TQNetworkOperation</a> can have. +<ul> +<li><tt>TQNetworkProtocol::StWaiting</tt> - The operation is in the TQNetworkProtocol's queue +waiting to be prcessed. +<li><tt>TQNetworkProtocol::StInProgress</tt> - The operation is being processed. +<li><tt>TQNetworkProtocol::StDone</tt> - The operation has been processed succesfully. +<li><tt>TQNetworkProtocol::StFailed</tt> - The operation has been processed but an error occurred. +<li><tt>TQNetworkProtocol::StStopped</tt> - The operation has been processed but has been +stopped before it finished, and is waiting to be processed. +</ul><p> +<hr><h2>Member Function Documentation</h2> +<h3 class=fn><a name="TQNetworkProtocol"></a>TQNetworkProtocol::TQNetworkProtocol () +</h3> +Constructor of the network protocol base class. Does some +initialization and connecting of signals and slots. + +<h3 class=fn><a name="~TQNetworkProtocol"></a>TQNetworkProtocol::~TQNetworkProtocol ()<tt> [virtual]</tt> +</h3> +Destructor. + +<h3 class=fn>void <a name="addOperation"></a>TQNetworkProtocol::addOperation ( <a href="qnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [virtual]</tt> +</h3> +Adds the operation <em>op</em> to the operation queue. The operation +will be processed as soon as possible. This method returns +immediately. + +<h3 class=fn>bool <a name="autoDelete"></a>TQNetworkProtocol::autoDelete () const +</h3> +Returns TRUE if auto-deleting is enabled; otherwise returns FALSE. +<p> <p>See also <a href="#setAutoDelete">TQNetworkProtocol::setAutoDelete</a>(). + +<h3 class=fn>bool <a name="checkConnection"></a>TQNetworkProtocol::checkConnection ( <a href="qnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [virtual protected]</tt> +</h3> +For processing operations the network protocol base class calls +this method tquite often. This should be reimplemented by new +network protocols. It should return TRUE if the connection is OK +(open); otherwise it should return FALSE. If the connection is not +open the protocol should open it. +<p> If the connection can't be opened (e.g. because you already tried +but the host couldn't be found), set the state of <em>op</em> to +TQNetworkProtocol::StFailed and emit the <a href="#finished">finished</a>() signal with +this <a href="qnetworkoperation.html">TQNetworkOperation</a> as argument. +<p> <em>op</em> is the operation that needs an open connection. + +<p>Example: <a href="networkprotocol-example.html#x673">network/networkprotocol/nntp.cpp</a>. +<h3 class=fn>void <a name="clearOperationQueue"></a>TQNetworkProtocol::clearOperationQueue ()<tt> [virtual]</tt> +</h3> +Clears the operation queue. + +<h3 class=fn>void <a name="connectionStateChanged"></a>TQNetworkProtocol::connectionStateChanged ( int state, const <a href="qstring.html">TQString</a> & data )<tt> [signal]</tt> +</h3> + +<p> This signal is emitted whenever the state of the connection of the +network protocol is changed. <em>state</em> describes the new state, +which is one of, <a href="#ConnectionState-enum">ConHostFound</a>, <a href="#ConnectionState-enum">ConConnected</a> or <a href="#ConnectionState-enum">ConClosed</a>. +<em>data</em> is a message text. + +<h3 class=fn>void <a name="createdDirectory"></a>TQNetworkProtocol::createdDirectory ( const <a href="qurlinfo.html">TQUrlInfo</a> & i, <a href="qnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [signal]</tt> +</h3> + +<p> This signal is emitted when mkdir() has been succesful and the +directory has been created. <em>i</em> holds the information about the +new directory. <em>op</em> is the pointer to the operation object which +contains all the information about the operation, including the +state, etc. Using op->arg( 0 ), you can get the file name of the +new directory. +<p> When a protocol emits this signal, TQNetworkProtocol is smart +enough to let the <a href="qurloperator.html">TQUrlOperator</a>, which is used by the network +protocol, emit its corresponding signal. + +<h3 class=fn>void <a name="data"></a>TQNetworkProtocol::data ( const <a href="qbytearray.html">TQByteArray</a> & data, <a href="qnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [signal]</tt> +</h3> + +<p> This signal is emitted when new <em>data</em> has been received after +calling get() or put(). <em>op</em> holds the name of the file from +which data is retrieved or uploaded in its first argument, and the +(raw) data in its second argument. You can get them with +op->arg( 0 ) and op->rawArg( 1 ). <em>op</em> is the pointer to the +operation object, which contains all the information about the +operation, including the state, etc. +<p> When a protocol emits this signal, TQNetworkProtocol is smart +enough to let the <a href="qurloperator.html">TQUrlOperator</a> (which is used by the network +protocol) emit its corresponding signal. + +<h3 class=fn>void <a name="dataTransferProgress"></a>TQNetworkProtocol::dataTransferProgress ( int bytesDone, int bytesTotal, <a href="qnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [signal]</tt> +</h3> + +<p> This signal is emitted during the transfer of data (using put() or +get()). <em>bytesDone</em> is how many bytes of <em>bytesTotal</em> have been +transferred. <em>bytesTotal</em> may be -1, which means that the total +number of bytes is not known. <em>op</em> is the pointer to the +operation object which contains all the information about the +operation, including the state, etc. +<p> When a protocol emits this signal, TQNetworkProtocol is smart +enough to let the <a href="qurloperator.html">TQUrlOperator</a>, which is used by the network +protocol, emit its corresponding signal. + +<h3 class=fn>void <a name="finished"></a>TQNetworkProtocol::finished ( <a href="qnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [signal]</tt> +</h3> + +<p> This signal is emitted when an operation finishes. This signal is +always emitted, for both success and failure. <em>op</em> is the pointer +to the operation object which contains all the information about +the operation, including the state, etc. Check the state and error +code of the operation object to determine whether or not the +operation was successful. +<p> When a protocol emits this signal, TQNetworkProtocol is smart +enough to let the <a href="qurloperator.html">TQUrlOperator</a>, which is used by the network +protocol, emit its corresponding signal. + +<h3 class=fn><a href="qnetworkprotocol.html">TQNetworkProtocol</a> * <a name="getNetworkProtocol"></a>TQNetworkProtocol::getNetworkProtocol ( const <a href="qstring.html">TQString</a> & protocol )<tt> [static]</tt> +</h3> +Static method to get a new instance of the network protocol <em>protocol</em>. For example, if you need to do some FTP operations, do +the following: +<pre> + <a href="qftp.html">TQFtp</a> *ftp = TQNetworkProtocol::<a href="#getNetworkProtocol">getNetworkProtocol</a>( "ftp" ); + </pre> + +This returns a pointer to a new instance of an ftp implementation +or null if no protocol for ftp was registered. The ownership of +the pointer is transferred to you, so you must delete it if you +don't need it anymore. +<p> Normally you should not work directly with network protocols, so +you will not need to call this method yourself. Instead, use +<a href="qurloperator.html">TQUrlOperator</a>, which makes working with network protocols much more +convenient. +<p> <p>See also <a href="qurloperator.html">TQUrlOperator</a>. + +<h3 class=fn>bool <a name="hasOnlyLocalFileSystem"></a>TQNetworkProtocol::hasOnlyLocalFileSystem ()<tt> [static]</tt> +</h3> +Returns TRUE if the only protocol registered is for working on the +local filesystem; returns FALSE if other network protocols are +also registered. + +<h3 class=fn>void <a name="itemChanged"></a>TQNetworkProtocol::itemChanged ( <a href="qnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [signal]</tt> +</h3> + +<p> This signal is emitted whenever a file which is a child of this +URL has been changed, e.g. by successfully calling rename(). <em>op</em> +holds the original and the new file names in the first and second +arguments, accessible with op->arg( 0 ) and op->arg( 1 ) +respectively. <em>op</em> is the pointer to the operation object which +contains all the information about the operation, including the +state, etc. +<p> When a protocol emits this signal, TQNetworkProtocol is smart +enough to let the <a href="qurloperator.html">TQUrlOperator</a>, which is used by the network +protocol, emit its corresponding signal. + +<h3 class=fn>void <a name="newChild"></a>TQNetworkProtocol::newChild ( const <a href="qurlinfo.html">TQUrlInfo</a> & i, <a href="qnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [signal]</tt> +</h3> + +<p> This signal is emitted if a new child (file) has been read. +TQNetworkProtocol automatically connects it to a slot which creates +a list of <a href="qurlinfo.html">TQUrlInfo</a> objects (with just one TQUrlInfo <em>i</em>) and emits +the <a href="#newChildren">newChildren</a>() signal with this list. <em>op</em> is the pointer to +the operation object which contains all the information about the +operation that has finished, including the state, etc. +<p> This is just a convenience signal useful for implementing your own +network protocol. In all other cases connect to the newChildren() +signal with its list of TQUrlInfo objects. + +<h3 class=fn>void <a name="newChildren"></a>TQNetworkProtocol::newChildren ( const <a href="qvaluelist.html">TQValueList</a><TQUrlInfo> & i, <a href="qnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [signal]</tt> +</h3> + +<p> This signal is emitted after listChildren() was called and new +children (files) have been read from the list of files. <em>i</em> holds +the information about the new children. <em>op</em> is the pointer to +the operation object which contains all the information about the +operation, including the state, etc. +<p> When a protocol emits this signal, TQNetworkProtocol is smart +enough to let the <a href="qurloperator.html">TQUrlOperator</a>, which is used by the network +protocol, emit its corresponding signal. +<p> When implementing your own network protocol and reading children, +you usually don't read one child at once, but rather a list of +them. That's why this signal takes a list of <a href="qurlinfo.html">TQUrlInfo</a> objects. If +you prefer to read just one child at a time you can use the +convenience signal <a href="#newChild">newChild</a>(), which takes a single TQUrlInfo +object. + +<h3 class=fn>void <a name="operationGet"></a>TQNetworkProtocol::operationGet ( <a href="qnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [virtual protected]</tt> +</h3> +When implementing a new network protocol, this method should be +reimplemented if the protocol supports getting data; this method +should then process the <a href="qnetworkoperation.html">TQNetworkOperation</a>. +<p> When you reimplement this method it's very important that you emit +the correct signals at the correct time (especially the <a href="#finished">finished</a>() +signal after processing an operation). Take a look at the <a href="network.html">TQt Network Documentation</a> which describes in +detail how to reimplement this method. You may also want to look +at the example implementation in +examples/network/networkprotocol/nntp.cpp. +<p> <em>op</em> is the pointer to the operation object which contains all +the information on the operation that has finished, including the +state, etc. + +<p>Example: <a href="networkprotocol-example.html#x674">network/networkprotocol/nntp.cpp</a>. +<h3 class=fn><a href="qnetworkoperation.html">TQNetworkOperation</a> * <a name="operationInProgress"></a>TQNetworkProtocol::operationInProgress () const +</h3> +Returns the operation, which is being processed, or 0 of no +operation is being processed at the moment. + +<h3 class=fn>void <a name="operationListChildren"></a>TQNetworkProtocol::operationListChildren ( <a href="qnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [virtual protected]</tt> +</h3> +When implementing a new network protocol, this method should be +reimplemented if the protocol supports listing children (files); +this method should then process this <a href="qnetworkoperation.html">TQNetworkOperation</a>. +<p> When you reimplement this method it's very important that you emit +the correct signals at the correct time (especially the <a href="#finished">finished</a>() +signal after processing an operation). Take a look at the <a href="network.html">TQt Network Documentation</a> which describes in +detail how to reimplement this method. You may also want to look +at the example implementation in +examples/network/networkprotocol/nntp.cpp. +<p> <em>op</em> is the pointer to the operation object which contains all +the information on the operation that has finished, including the +state, etc. + +<p>Example: <a href="networkprotocol-example.html#x675">network/networkprotocol/nntp.cpp</a>. +<h3 class=fn>void <a name="operationMkDir"></a>TQNetworkProtocol::operationMkDir ( <a href="qnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [virtual protected]</tt> +</h3> +When implementing a new network protocol, this method should be +reimplemented if the protocol supports making directories; this +method should then process this <a href="qnetworkoperation.html">TQNetworkOperation</a>. +<p> When you reimplement this method it's very important that you emit +the correct signals at the correct time (especially the <a href="#finished">finished</a>() +signal after processing an operation). Take a look at the <a href="network.html">TQt Network Documentation</a> which describes in +detail how to reimplement this method. You may also want to look +at the example implementation in +examples/network/networkprotocol/nntp.cpp. +<p> <em>op</em> is the pointer to the operation object which contains all +the information on the operation that has finished, including the +state, etc. + +<h3 class=fn>void <a name="operationPut"></a>TQNetworkProtocol::operationPut ( <a href="qnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [virtual protected]</tt> +</h3> +When implementing a new network protocol, this method should be +reimplemented if the protocol supports putting (uploading) data; +this method should then process the <a href="qnetworkoperation.html">TQNetworkOperation</a>. +<p> When you reimplement this method it's very important that you emit +the correct signals at the correct time (especially the <a href="#finished">finished</a>() +signal after processing an operation). Take a look at the <a href="network.html">TQt Network Documentation</a> which describes in +detail how to reimplement this method. You may also want to look +at the example implementation in +examples/network/networkprotocol/nntp.cpp. +<p> <em>op</em> is the pointer to the operation object which contains all +the information on the operation that has finished, including the +state, etc. + +<h3 class=fn>void <a name="operationRemove"></a>TQNetworkProtocol::operationRemove ( <a href="qnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [virtual protected]</tt> +</h3> +When implementing a new network protocol, this method should be +reimplemented if the protocol supports removing children (files); +this method should then process this <a href="qnetworkoperation.html">TQNetworkOperation</a>. +<p> When you reimplement this method it's very important that you emit +the correct signals at the correct time (especially the <a href="#finished">finished</a>() +signal after processing an operation). Take a look at the <a href="network.html">TQt Network Documentation</a> which is describes +in detail how to reimplement this method. You may also want to +look at the example implementation in +examples/network/networkprotocol/nntp.cpp. +<p> <em>op</em> is the pointer to the operation object which contains all +the information on the operation that has finished, including the +state, etc. + +<h3 class=fn>void <a name="operationRename"></a>TQNetworkProtocol::operationRename ( <a href="qnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [virtual protected]</tt> +</h3> +When implementing a new newtork protocol, this method should be +reimplemented if the protocol supports renaming children (files); +this method should then process this <a href="qnetworkoperation.html">TQNetworkOperation</a>. +<p> When you reimplement this method it's very important that you emit +the correct signals at the correct time (especially the <a href="#finished">finished</a>() +signal after processing an operation). Take a look at the <a href="network.html">TQt Network Documentation</a> which describes in +detail how to reimplement this method. You may also want to look +at the example implementation in +examples/network/networkprotocol/nntp.cpp. +<p> <em>op</em> is the pointer to the operation object which contains all +the information on the operation that has finished, including the +state, etc. + +<h3 class=fn>void <a name="registerNetworkProtocol"></a>TQNetworkProtocol::registerNetworkProtocol ( const <a href="qstring.html">TQString</a> & protocol, TQNetworkProtocolFactoryBase * protocolFactory )<tt> [static]</tt> +</h3> +Static method to register a network protocol for TQt. For example, +if you have an implementation of NNTP (called Nntp) which is +derived from TQNetworkProtocol, call: +<pre> + TQNetworkProtocol::<a href="#registerNetworkProtocol">registerNetworkProtocol</a>( "nntp", new TQNetworkProtocolFactory<Nntp> ); + </pre> + +after which your implementation is registered for future nntp +operations. +<p> The name of the protocol is given in <em>protocol</em> and a pointer to +the protocol factory is given in <em>protocolFactory</em>. + +<h3 class=fn>void <a name="removed"></a>TQNetworkProtocol::removed ( <a href="qnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [signal]</tt> +</h3> + +<p> This signal is emitted when remove() has been succesful and the +file has been removed. <em>op</em> holds the file name of the removed +file in the first argument, accessible with op->arg( 0 ). <em>op</em> is +the pointer to the operation object which contains all the +information about the operation, including the state, etc. +<p> When a protocol emits this signal, TQNetworkProtocol is smart +enough to let the <a href="qurloperator.html">TQUrlOperator</a>, which is used by the network +protocol, emit its corresponding signal. + +<h3 class=fn>void <a name="setAutoDelete"></a>TQNetworkProtocol::setAutoDelete ( bool b, int i = 10000 )<tt> [virtual]</tt> +</h3> +Because it's sometimes hard to take care of removing network +protocol instances, TQNetworkProtocol provides an auto-delete +mechanism. If you set <em>b</em> to TRUE, the network protocol instance +is removed after it has been inactive for <em>i</em> milliseconds (i.e. +<em>i</em> milliseconds after the last operation has been processed). +If you set <em>b</em> to FALSE the auto-delete mechanism is switched +off. +<p> If you switch on auto-delete, the TQNetworkProtocol also deletes +its <a href="qurloperator.html">TQUrlOperator</a>. + +<h3 class=fn>void <a name="setUrl"></a>TQNetworkProtocol::setUrl ( <a href="qurloperator.html">TQUrlOperator</a> * u )<tt> [virtual]</tt> +</h3> +Sets the <a href="qurloperator.html">TQUrlOperator</a>, on which the protocol works, to <em>u</em>. +<p> <p>See also <a href="qurloperator.html">TQUrlOperator</a>. + +<h3 class=fn>void <a name="start"></a>TQNetworkProtocol::start ( <a href="qnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [signal]</tt> +</h3> + +<p> Some operations (such as listChildren()) emit this signal when +they start processing the operation. <em>op</em> is the pointer to the +operation object which contains all the information about the +operation, including the state, etc. +<p> When a protocol emits this signal, TQNetworkProtocol is smart +enough to let the <a href="qurloperator.html">TQUrlOperator</a>, which is used by the network +protocol, emit its corresponding signal. + +<h3 class=fn>void <a name="stop"></a>TQNetworkProtocol::stop ()<tt> [virtual]</tt> +</h3> +Stops the current operation that is being processed and clears all +waiting operations. + +<h3 class=fn>int <a name="supportedOperations"></a>TQNetworkProtocol::supportedOperations () const<tt> [virtual]</tt> +</h3> +Returns an int that is OR'd together using the enum values of +<a href="#Operation-enum">TQNetworkProtocol::Operation</a>, which describes which operations +are supported by the network protocol. Should be reimplemented by +new network protocols. + +<p>Example: <a href="networkprotocol-example.html#x676">network/networkprotocol/nntp.cpp</a>. +<h3 class=fn><a href="qurloperator.html">TQUrlOperator</a> * <a name="url"></a>TQNetworkProtocol::url () const +</h3> +Returns the <a href="qurloperator.html">TQUrlOperator</a> on which the protocol works. + +<!-- 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> |