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

« back to all changes in this revision

Viewing changes to doc/html/q3networkprotocol.html

  • Committer: Bazaar Package Importer
  • Author(s): Alessandro Ghersi
  • Date: 2009-11-02 18:30:08 UTC
  • mfrom: (1.2.2 upstream)
  • mto: (15.2.5 experimental)
  • mto: This revision was merged to the branch mainline in revision 88.
  • Revision ID: james.westby@ubuntu.com-20091102183008-b6a4gcs128mvfb3m
Tags: upstream-4.6.0~beta1
ImportĀ upstreamĀ versionĀ 4.6.0~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
<!DOCTYPE html
3
3
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
4
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
 
<!-- /fasttmp/mkdist-qt-4.5.2-1245473805/qt-x11-opensource-src-4.5.2/src/qt3support/network/q3networkprotocol.cpp -->
 
5
<!-- q3networkprotocol.cpp -->
6
6
<head>
7
 
  <title>Qt 4.5: Q3NetworkProtocol Class Reference</title>
 
7
  <title>Qt 4.6: Q3NetworkProtocol Class Reference</title>
8
8
  <link href="classic.css" rel="stylesheet" type="text/css" />
9
9
</head>
10
10
<body>
 
11
<a name="//apple_ref/cpp/cl//Q3NetworkProtocol" />
11
12
<table border="0" cellpadding="0" cellspacing="0" width="100%">
12
13
<tr>
13
 
<td align="left" valign="top" width="32"><a href="http://qtsoftware.com/products/qt"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
14
 
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="namespaces.html"><font color="#004faf">All&nbsp;Namespaces</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="mainclasses.html"><font color="#004faf">Main&nbsp;Classes</font></a>&nbsp;&middot; <a href="groups.html"><font color="#004faf">Grouped&nbsp;Classes</font></a>&nbsp;&middot; <a href="modules.html"><font color="#004faf">Modules</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">Functions</font></a></td>
15
 
<td align="right" valign="top" width="230"></td></tr></table><h1 class="title">Q3NetworkProtocol Class Reference<br /><span class="small-subtitle">[<a href="qt3support.html">Qt3Support</a> module]</span>
 
14
<td align="left" valign="top" width="32"><a href="http://qt.nokia.com/"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
 
15
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">All&nbsp;Functions</font></a>&nbsp;&middot; <a href="overviews.html"><font color="#004faf">Overviews</font></a></td><td class="searchBar" align="right" valign="center"><form action="http://www.google.com/cse" id="cse-search-box"><div><input type="hidden" name="cx" value="000136343326384750312:dhbxnqlakyu" /><input type="hidden" name="ie" value="UTF-8" /><input type="text" name="q" size="31" /><input type="submit" name="sa" value="Search" /></div></form></td>
 
16
</tr></table><h1 class="title">Q3NetworkProtocol Class Reference<br /><span class="small-subtitle">[<a href="qt3support.html">Qt3Support</a> module]</span>
16
17
</h1>
17
18
<p>The Q3NetworkProtocol class provides a common API for network protocols. <a href="#details">More...</a></p>
18
19
<pre> #include &lt;Q3NetworkProtocol&gt;</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#qnetworkprotocol">Porting to Qt 4</a> for more information.</p>
21
22
<ul>
22
23
<li><a href="q3networkprotocol-members.html">List of all members, including inherited members</a></li>
23
24
</ul>
 
25
<hr />
24
26
<a name="public-types"></a>
25
 
<h3>Public Types</h3>
26
 
<ul>
27
 
<li><div class="fn"></div>enum <b><a href="q3networkprotocol.html#ConnectionState-enum">ConnectionState</a></b> { ConHostFound, ConConnected, ConClosed }</li>
28
 
<li><div class="fn"></div>enum <b><a href="q3networkprotocol.html#Error-enum">Error</a></b> { NoError, ErrValid, ErrUnknownProtocol, ErrUnsupported, ..., ErrPermissionDenied }</li>
29
 
<li><div class="fn"></div>enum <b><a href="q3networkprotocol.html#Operation-enum">Operation</a></b> { OpListChildren, OpMkDir, OpRemove, OpRename, OpGet, OpPut }</li>
30
 
<li><div class="fn"></div>enum <b><a href="q3networkprotocol.html#State-enum">State</a></b> { StWaiting, StInProgress, StDone, StFailed, StStopped }</li>
31
 
</ul>
 
27
<h2>Public Types</h2>
 
28
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
29
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#ConnectionState-enum">ConnectionState</a></b> { ConHostFound, ConConnected, ConClosed }</td></tr>
 
30
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#Error-enum">Error</a></b> { NoError, ErrValid, ErrUnknownProtocol, ErrUnsupported, ..., ErrPermissionDenied }</td></tr>
 
31
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#Operation-enum">Operation</a></b> { OpListChildren, OpMkDir, OpRemove, OpRename, OpGet, OpPut }</td></tr>
 
32
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#State-enum">State</a></b> { StWaiting, StInProgress, StDone, StFailed, StStopped }</td></tr>
 
33
</table>
 
34
<hr />
32
35
<a name="public-functions"></a>
33
 
<h3>Public Functions</h3>
34
 
<ul>
35
 
<li><div class="fn"></div><b><a href="q3networkprotocol.html#Q3NetworkProtocol">Q3NetworkProtocol</a></b> ()</li>
36
 
<li><div class="fn"></div>virtual <b><a href="q3networkprotocol.html#dtor.Q3NetworkProtocol">~Q3NetworkProtocol</a></b> ()</li>
37
 
<li><div class="fn"></div>virtual void <b><a href="q3networkprotocol.html#addOperation">addOperation</a></b> ( Q3NetworkOperation * <i>op</i> )</li>
38
 
<li><div class="fn"></div>bool <b><a href="q3networkprotocol.html#autoDelete">autoDelete</a></b> () const</li>
39
 
<li><div class="fn"></div>virtual void <b><a href="q3networkprotocol.html#clearOperationQueue">clearOperationQueue</a></b> ()</li>
40
 
<li><div class="fn"></div>Q3NetworkOperation * <b><a href="q3networkprotocol.html#operationInProgress">operationInProgress</a></b> () const</li>
41
 
<li><div class="fn"></div>virtual void <b><a href="q3networkprotocol.html#setAutoDelete">setAutoDelete</a></b> ( bool <i>b</i>, int <i>i</i> = 10000 )</li>
42
 
<li><div class="fn"></div>virtual void <b><a href="q3networkprotocol.html#setUrl">setUrl</a></b> ( Q3UrlOperator * <i>u</i> )</li>
43
 
<li><div class="fn"></div>virtual void <b><a href="q3networkprotocol.html#stop">stop</a></b> ()</li>
44
 
<li><div class="fn"></div>virtual int <b><a href="q3networkprotocol.html#supportedOperations">supportedOperations</a></b> () const</li>
45
 
<li><div class="fn"></div>Q3UrlOperator * <b><a href="q3networkprotocol.html#url">url</a></b> () const</li>
46
 
</ul>
47
 
<ul>
48
 
<li><div class="fn"></div>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
49
 
</ul>
 
36
<h2>Public Functions</h2>
 
37
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
38
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#Q3NetworkProtocol">Q3NetworkProtocol</a></b> ()</td></tr>
 
39
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#dtor.Q3NetworkProtocol">~Q3NetworkProtocol</a></b> ()</td></tr>
 
40
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#addOperation">addOperation</a></b> ( Q3NetworkOperation * <i>op</i> )</td></tr>
 
41
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#autoDelete">autoDelete</a></b> () const</td></tr>
 
42
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#clearOperationQueue">clearOperationQueue</a></b> ()</td></tr>
 
43
<tr><td class="memItemLeft" align="right" valign="top">Q3NetworkOperation * </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#operationInProgress">operationInProgress</a></b> () const</td></tr>
 
44
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#setAutoDelete">setAutoDelete</a></b> ( bool <i>b</i>, int <i>i</i> = 10000 )</td></tr>
 
45
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#setUrl">setUrl</a></b> ( Q3UrlOperator * <i>u</i> )</td></tr>
 
46
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#stop">stop</a></b> ()</td></tr>
 
47
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#supportedOperations">supportedOperations</a></b> () const</td></tr>
 
48
<tr><td class="memItemLeft" align="right" valign="top">Q3UrlOperator * </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#url">url</a></b> () const</td></tr>
 
49
</table>
 
50
<ul>
 
51
<li><div bar="2" class="fn"></div>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
 
52
</ul>
 
53
<hr />
50
54
<a name="signals"></a>
51
 
<h3>Signals</h3>
52
 
<ul>
53
 
<li><div class="fn"></div>void <b><a href="q3networkprotocol.html#connectionStateChanged">connectionStateChanged</a></b> ( int <i>state</i>, const QString &amp; <i>data</i> )</li>
54
 
<li><div class="fn"></div>void <b><a href="q3networkprotocol.html#createdDirectory">createdDirectory</a></b> ( const QUrlInfo &amp; <i>i</i>, Q3NetworkOperation * <i>op</i> )</li>
55
 
<li><div class="fn"></div>void <b><a href="q3networkprotocol.html#data">data</a></b> ( const QByteArray &amp; <i>data</i>, Q3NetworkOperation * <i>op</i> )</li>
56
 
<li><div class="fn"></div>void <b><a href="q3networkprotocol.html#dataTransferProgress">dataTransferProgress</a></b> ( int <i>bytesDone</i>, int <i>bytesTotal</i>, Q3NetworkOperation * <i>op</i> )</li>
57
 
<li><div class="fn"></div>void <b><a href="q3networkprotocol.html#finished">finished</a></b> ( Q3NetworkOperation * <i>op</i> )</li>
58
 
<li><div class="fn"></div>void <b><a href="q3networkprotocol.html#itemChanged">itemChanged</a></b> ( Q3NetworkOperation * <i>op</i> )</li>
59
 
<li><div class="fn"></div>void <b><a href="q3networkprotocol.html#newChild">newChild</a></b> ( const QUrlInfo &amp; <i>i</i>, Q3NetworkOperation * <i>op</i> )</li>
60
 
<li><div class="fn"></div>void <b><a href="q3networkprotocol.html#newChildren">newChildren</a></b> ( const Q3ValueList&lt;QUrlInfo&gt; &amp; <i>i</i>, Q3NetworkOperation * <i>op</i> )</li>
61
 
<li><div class="fn"></div>void <b><a href="q3networkprotocol.html#removed">removed</a></b> ( Q3NetworkOperation * <i>op</i> )</li>
62
 
<li><div class="fn"></div>void <b><a href="q3networkprotocol.html#start">start</a></b> ( Q3NetworkOperation * <i>op</i> )</li>
63
 
</ul>
64
 
<ul>
65
 
<li><div class="fn"></div>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
66
 
</ul>
 
55
<h2>Signals</h2>
 
56
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
57
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#connectionStateChanged">connectionStateChanged</a></b> ( int <i>state</i>, const QString &amp; <i>data</i> )</td></tr>
 
58
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#createdDirectory">createdDirectory</a></b> ( const QUrlInfo &amp; <i>i</i>, Q3NetworkOperation * <i>op</i> )</td></tr>
 
59
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#data">data</a></b> ( const QByteArray &amp; <i>data</i>, Q3NetworkOperation * <i>op</i> )</td></tr>
 
60
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#dataTransferProgress">dataTransferProgress</a></b> ( int <i>bytesDone</i>, int <i>bytesTotal</i>, Q3NetworkOperation * <i>op</i> )</td></tr>
 
61
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#finished">finished</a></b> ( Q3NetworkOperation * <i>op</i> )</td></tr>
 
62
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#itemChanged">itemChanged</a></b> ( Q3NetworkOperation * <i>op</i> )</td></tr>
 
63
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#newChild">newChild</a></b> ( const QUrlInfo &amp; <i>i</i>, Q3NetworkOperation * <i>op</i> )</td></tr>
 
64
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#newChildren">newChildren</a></b> ( const Q3ValueList&lt;QUrlInfo&gt; &amp; <i>i</i>, Q3NetworkOperation * <i>op</i> )</td></tr>
 
65
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#removed">removed</a></b> ( Q3NetworkOperation * <i>op</i> )</td></tr>
 
66
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#start">start</a></b> ( Q3NetworkOperation * <i>op</i> )</td></tr>
 
67
</table>
 
68
<ul>
 
69
<li><div bar="2" class="fn"></div>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
 
70
</ul>
 
71
<hr />
67
72
<a name="static-public-members"></a>
68
 
<h3>Static Public Members</h3>
69
 
<ul>
70
 
<li><div class="fn"></div>Q3NetworkProtocol * <b><a href="q3networkprotocol.html#getNetworkProtocol">getNetworkProtocol</a></b> ( const QString &amp; <i>protocol</i> )</li>
71
 
<li><div class="fn"></div>bool <b><a href="q3networkprotocol.html#hasOnlyLocalFileSystem">hasOnlyLocalFileSystem</a></b> ()</li>
72
 
<li><div class="fn"></div>void <b><a href="q3networkprotocol.html#registerNetworkProtocol">registerNetworkProtocol</a></b> ( const QString &amp; <i>protocol</i>, Q3NetworkProtocolFactoryBase * <i>protocolFactory</i> )</li>
73
 
</ul>
74
 
<ul>
75
 
<li><div class="fn"></div>5 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
76
 
</ul>
 
73
<h2>Static Public Members</h2>
 
74
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
75
<tr><td class="memItemLeft" align="right" valign="top">Q3NetworkProtocol * </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#getNetworkProtocol">getNetworkProtocol</a></b> ( const QString &amp; <i>protocol</i> )</td></tr>
 
76
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#hasOnlyLocalFileSystem">hasOnlyLocalFileSystem</a></b> ()</td></tr>
 
77
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#registerNetworkProtocol">registerNetworkProtocol</a></b> ( const QString &amp; <i>protocol</i>, Q3NetworkProtocolFactoryBase * <i>protocolFactory</i> )</td></tr>
 
78
</table>
 
79
<ul>
 
80
<li><div bar="2" class="fn"></div>5 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
 
81
</ul>
 
82
<hr />
77
83
<a name="protected-functions"></a>
78
 
<h3>Protected Functions</h3>
79
 
<ul>
80
 
<li><div class="fn"></div>virtual bool <b><a href="q3networkprotocol.html#checkConnection">checkConnection</a></b> ( Q3NetworkOperation * <i>op</i> )</li>
81
 
<li><div class="fn"></div>virtual void <b><a href="q3networkprotocol.html#operationGet">operationGet</a></b> ( Q3NetworkOperation * <i>op</i> )</li>
82
 
<li><div class="fn"></div>virtual void <b><a href="q3networkprotocol.html#operationListChildren">operationListChildren</a></b> ( Q3NetworkOperation * <i>op</i> )</li>
83
 
<li><div class="fn"></div>virtual void <b><a href="q3networkprotocol.html#operationMkDir">operationMkDir</a></b> ( Q3NetworkOperation * <i>op</i> )</li>
84
 
<li><div class="fn"></div>virtual void <b><a href="q3networkprotocol.html#operationPut">operationPut</a></b> ( Q3NetworkOperation * <i>op</i> )</li>
85
 
<li><div class="fn"></div>virtual void <b><a href="q3networkprotocol.html#operationRemove">operationRemove</a></b> ( Q3NetworkOperation * <i>op</i> )</li>
86
 
<li><div class="fn"></div>virtual void <b><a href="q3networkprotocol.html#operationRename">operationRename</a></b> ( Q3NetworkOperation * <i>op</i> )</li>
87
 
</ul>
88
 
<ul>
89
 
<li><div class="fn"></div>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
 
84
<h2>Protected Functions</h2>
 
85
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
86
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#checkConnection">checkConnection</a></b> ( Q3NetworkOperation * <i>op</i> )</td></tr>
 
87
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#operationGet">operationGet</a></b> ( Q3NetworkOperation * <i>op</i> )</td></tr>
 
88
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#operationListChildren">operationListChildren</a></b> ( Q3NetworkOperation * <i>op</i> )</td></tr>
 
89
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#operationMkDir">operationMkDir</a></b> ( Q3NetworkOperation * <i>op</i> )</td></tr>
 
90
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#operationPut">operationPut</a></b> ( Q3NetworkOperation * <i>op</i> )</td></tr>
 
91
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#operationRemove">operationRemove</a></b> ( Q3NetworkOperation * <i>op</i> )</td></tr>
 
92
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="q3networkprotocol.html#operationRename">operationRename</a></b> ( Q3NetworkOperation * <i>op</i> )</td></tr>
 
93
</table>
 
94
<ul>
 
95
<li><div bar="2" class="fn"></div>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
90
96
</ul>
91
97
<h3>Additional Inherited Members</h3>
92
98
<ul>
102
108
<p>When you implement a network protocol this way, it is important to emit the correct signals. Also, always emit the <a href="q3networkprotocol.html#finished">finished</a>() signal when an operation is done (on success <i>and</i> on failure). Qt relies on correctly emitted <a href="q3networkprotocol.html#finished">finished</a>() signals.</p>
103
109
<hr />
104
110
<h2>Member Type Documentation</h2>
 
111
<a name="//apple_ref/cpp/tag/Q3NetworkProtocol/ConnectionState" />
 
112
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/ConHostFound" />
 
113
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/ConConnected" />
 
114
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/ConClosed" />
105
115
<h3 class="fn"><a name="ConnectionState-enum"></a>enum Q3NetworkProtocol::ConnectionState</h3>
106
116
<p>When the connection state of a network protocol changes it emits the signal <a href="q3networkprotocol.html#connectionStateChanged">connectionStateChanged</a>(). The first argument is one of the following values:</p>
107
 
<p><table border="1" cellpadding="2" cellspacing="1" width="100%">
 
117
<p><table class="valuelist" border="1" cellpadding="2" cellspacing="1" width="100%">
108
118
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
109
119
<tr><td valign="top"><tt>Q3NetworkProtocol::ConHostFound</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">Host has been found.</td></tr>
110
120
<tr><td valign="top"><tt>Q3NetworkProtocol::ConConnected</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">Connection to the host has been established.</td></tr>
111
121
<tr><td valign="top"><tt>Q3NetworkProtocol::ConClosed</tt></td><td align="center" valign="top"><tt>2</tt></td><td valign="top">Connection has been closed.</td></tr>
112
122
</table></p>
 
123
<a name="//apple_ref/cpp/tag/Q3NetworkProtocol/Error" />
 
124
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/NoError" />
 
125
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/ErrValid" />
 
126
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/ErrUnknownProtocol" />
 
127
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/ErrUnsupported" />
 
128
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/ErrParse" />
 
129
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/ErrLoginIncorrect" />
 
130
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/ErrHostNotFound" />
 
131
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/ErrListChildren" />
 
132
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/ErrMkDir" />
 
133
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/ErrRemove" />
 
134
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/ErrRename" />
 
135
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/ErrGet" />
 
136
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/ErrPut" />
 
137
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/ErrFileNotExisting" />
 
138
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/ErrPermissionDenied" />
 
139
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/ErrMkdir" />
 
140
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/ErrListChlidren" />
113
141
<h3 class="fn"><a name="Error-enum"></a>enum Q3NetworkProtocol::Error</h3>
114
 
<p>When an operation fails (finishes unsuccessfully), the <a href="q3networkoperation.html">Q3NetworkOperation</a> of the operation returns an error code which has one of the following values:</p>
115
 
<p><table border="1" cellpadding="2" cellspacing="1" width="100%">
 
142
<p>When an operation fails (finishes unsuccessfully), the <a href="q3networkoperation.html" class="compat">Q3NetworkOperation</a> of the operation returns an error code which has one of the following values:</p>
 
143
<p><table class="valuelist" border="1" cellpadding="2" cellspacing="1" width="100%">
116
144
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
117
145
<tr><td valign="top"><tt>Q3NetworkProtocol::NoError</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">No error occurred.</td></tr>
118
146
<tr><td valign="top"><tt>Q3NetworkProtocol::ErrValid</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">The URL you are operating on is not valid.</td></tr>
131
159
<tr><td valign="top"><tt>Q3NetworkProtocol::ErrPermissionDenied</tt></td><td align="center" valign="top">?</td><td valign="top">Permission for doing the operation has been denied.</td></tr>
132
160
</table></p>
133
161
<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.</p>
 
162
<a name="//apple_ref/cpp/tag/Q3NetworkProtocol/Operation" />
 
163
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/OpListChildren" />
 
164
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/OpMkDir" />
 
165
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/OpRemove" />
 
166
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/OpRename" />
 
167
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/OpGet" />
 
168
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/OpPut" />
 
169
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/OpMkdir" />
134
170
<h3 class="fn"><a name="Operation-enum"></a>enum Q3NetworkProtocol::Operation</h3>
135
 
<p>This enum lists the possible operations that a network protocol can support. <a href="q3networkprotocol.html#supportedOperations">supportedOperations</a>() returns an int of these that is OR'd together. Also, the type() of a <a href="q3networkoperation.html">Q3NetworkOperation</a> is always one of these values.</p>
136
 
<p><table border="1" cellpadding="2" cellspacing="1" width="100%">
 
171
<p>This enum lists the possible operations that a network protocol can support. <a href="q3networkprotocol.html#supportedOperations">supportedOperations</a>() returns an int of these that is OR'd together. Also, the type() of a <a href="q3networkoperation.html" class="compat">Q3NetworkOperation</a> is always one of these values.</p>
 
172
<p><table class="valuelist" border="1" cellpadding="2" cellspacing="1" width="100%">
137
173
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
138
174
<tr><td valign="top"><tt>Q3NetworkProtocol::OpListChildren</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">List the children of a URL, e.g&#x2e; of a directory.</td></tr>
139
175
<tr><td valign="top"><tt>Q3NetworkProtocol::OpMkDir</tt></td><td align="center" valign="top"><tt>2</tt></td><td valign="top">Create a directory.</td></tr>
142
178
<tr><td valign="top"><tt>Q3NetworkProtocol::OpGet</tt></td><td align="center" valign="top"><tt>32</tt></td><td valign="top">Get data from a location.</td></tr>
143
179
<tr><td valign="top"><tt>Q3NetworkProtocol::OpPut</tt></td><td align="center" valign="top"><tt>64</tt></td><td valign="top">Put data to a location.</td></tr>
144
180
</table></p>
 
181
<a name="//apple_ref/cpp/tag/Q3NetworkProtocol/State" />
 
182
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/StWaiting" />
 
183
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/StInProgress" />
 
184
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/StDone" />
 
185
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/StFailed" />
 
186
<a name="//apple_ref/cpp/econst/Q3NetworkProtocol/StStopped" />
145
187
<h3 class="fn"><a name="State-enum"></a>enum Q3NetworkProtocol::State</h3>
146
 
<p>This enum contains the state that a <a href="q3networkoperation.html">Q3NetworkOperation</a> can have.</p>
147
 
<p><table border="1" cellpadding="2" cellspacing="1" width="100%">
 
188
<p>This enum contains the state that a <a href="q3networkoperation.html" class="compat">Q3NetworkOperation</a> can have.</p>
 
189
<p><table class="valuelist" border="1" cellpadding="2" cellspacing="1" width="100%">
148
190
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
149
 
<tr><td valign="top"><tt>Q3NetworkProtocol::StWaiting</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">The operation is in the <a href="q3networkprotocol.html">Q3NetworkProtocol</a>'s queue waiting to be prcessed.</td></tr>
 
191
<tr><td valign="top"><tt>Q3NetworkProtocol::StWaiting</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">The operation is in the <a href="q3networkprotocol.html" class="compat">Q3NetworkProtocol</a>'s queue waiting to be prcessed.</td></tr>
150
192
<tr><td valign="top"><tt>Q3NetworkProtocol::StInProgress</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">The operation is being processed.</td></tr>
151
193
<tr><td valign="top"><tt>Q3NetworkProtocol::StDone</tt></td><td align="center" valign="top"><tt>2</tt></td><td valign="top">The operation has been processed successfully.</td></tr>
152
194
<tr><td valign="top"><tt>Q3NetworkProtocol::StFailed</tt></td><td align="center" valign="top"><tt>3</tt></td><td valign="top">The operation has been processed but an error occurred.</td></tr>
154
196
</table></p>
155
197
<hr />
156
198
<h2>Member Function Documentation</h2>
 
199
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/Q3NetworkProtocol" />
157
200
<h3 class="fn"><a name="Q3NetworkProtocol"></a>Q3NetworkProtocol::Q3NetworkProtocol ()</h3>
158
201
<p>Constructor of the network protocol base class. Does some initialization and connecting of signals and slots.</p>
 
202
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/~Q3NetworkProtocol" />
159
203
<h3 class="fn"><a name="dtor.Q3NetworkProtocol"></a>Q3NetworkProtocol::~Q3NetworkProtocol ()&nbsp;&nbsp;<tt> [virtual]</tt></h3>
160
204
<p>Destructor.</p>
 
205
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/addOperation" />
161
206
<h3 class="fn"><a name="addOperation"></a>void Q3NetworkProtocol::addOperation ( <a href="q3networkoperation.html">Q3NetworkOperation</a> * <i>op</i> )&nbsp;&nbsp;<tt> [virtual]</tt></h3>
162
207
<p>Adds the operation <i>op</i> to the operation queue. The operation will be processed as soon as possible. This method returns immediately.</p>
 
208
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/autoDelete" />
163
209
<h3 class="fn"><a name="autoDelete"></a>bool Q3NetworkProtocol::autoDelete () const</h3>
164
210
<p>Returns true if auto-deleting is enabled; otherwise returns false.</p>
165
211
<p>See also <a href="q3networkprotocol.html#setAutoDelete">Q3NetworkProtocol::setAutoDelete</a>().</p>
 
212
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/checkConnection" />
166
213
<h3 class="fn"><a name="checkConnection"></a>bool Q3NetworkProtocol::checkConnection ( <a href="q3networkoperation.html">Q3NetworkOperation</a> * <i>op</i> )&nbsp;&nbsp;<tt> [virtual protected]</tt></h3>
167
214
<p>For processing operations the network protocol base class calls this method quite 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>
168
 
<p>If the connection can't be opened (e.g&#x2e; because you already tried but the host couldn't be found), set the state of <i>op</i> to <a href="q3networkprotocol.html#State-enum">Q3NetworkProtocol::StFailed</a> and emit the <a href="q3networkprotocol.html#finished">finished</a>() signal with this <a href="q3networkoperation.html">Q3NetworkOperation</a> as argument.</p>
 
215
<p>If the connection can't be opened (e.g&#x2e; because you already tried but the host couldn't be found), set the state of <i>op</i> to <a href="q3networkprotocol.html#State-enum">Q3NetworkProtocol::StFailed</a> and emit the <a href="q3networkprotocol.html#finished">finished</a>() signal with this <a href="q3networkoperation.html" class="compat">Q3NetworkOperation</a> as argument.</p>
169
216
<p><i>op</i> is the operation that needs an open connection.</p>
 
217
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/clearOperationQueue" />
170
218
<h3 class="fn"><a name="clearOperationQueue"></a>void Q3NetworkProtocol::clearOperationQueue ()&nbsp;&nbsp;<tt> [virtual]</tt></h3>
171
219
<p>Clears the operation queue.</p>
 
220
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/connectionStateChanged" />
172
221
<h3 class="fn"><a name="connectionStateChanged"></a>void Q3NetworkProtocol::connectionStateChanged ( int <i>state</i>, const <a href="qstring.html">QString</a> &amp; <i>data</i> )&nbsp;&nbsp;<tt> [signal]</tt></h3>
173
222
<p>This signal is emitted whenever the state of the connection of the network protocol is changed. <i>state</i> describes the new state, which is one of, <tt>ConHostFound</tt>, <tt>ConConnected</tt> or <tt>ConClosed</tt>. <i>data</i> is a message text.</p>
 
223
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/createdDirectory" />
174
224
<h3 class="fn"><a name="createdDirectory"></a>void Q3NetworkProtocol::createdDirectory ( const <a href="qurlinfo.html">QUrlInfo</a> &amp; <i>i</i>, <a href="q3networkoperation.html">Q3NetworkOperation</a> * <i>op</i> )&nbsp;&nbsp;<tt> [signal]</tt></h3>
175
225
<p>This signal is emitted when mkdir() has been successful and the directory has been created. <i>i</i> holds the information about the new directory. <i>op</i> is the pointer to the operation object which contains all the information about the operation, including the state, etc. Using op-&gt;arg( 0 ), you can get the file name of the new directory.</p>
176
 
<p>When a protocol emits this signal, <a href="q3networkprotocol.html">Q3NetworkProtocol</a> is smart enough to let the <a href="q3urloperator.html">Q3UrlOperator</a>, which is used by the network protocol, emit its corresponding signal.</p>
 
226
<p>When a protocol emits this signal, <a href="q3networkprotocol.html" class="compat">Q3NetworkProtocol</a> is smart enough to let the <a href="q3urloperator.html" class="compat">Q3UrlOperator</a>, which is used by the network protocol, emit its corresponding signal.</p>
 
227
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/data" />
177
228
<h3 class="fn"><a name="data"></a>void Q3NetworkProtocol::data ( const <a href="qbytearray.html">QByteArray</a> &amp; <i>data</i>, <a href="q3networkoperation.html">Q3NetworkOperation</a> * <i>op</i> )&nbsp;&nbsp;<tt> [signal]</tt></h3>
178
229
<p>This signal is emitted when new <i>data</i> has been received after calling get() or put(). <i>op</i> 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-&gt;arg( 0 ) and op-&gt;rawArg( 1 ). <i>op</i> is the pointer to the operation object, which contains all the information about the operation, including the state, etc.</p>
179
 
<p>When a protocol emits this signal, <a href="q3networkprotocol.html">Q3NetworkProtocol</a> is smart enough to let the <a href="q3urloperator.html">Q3UrlOperator</a> (which is used by the network protocol) emit its corresponding signal.</p>
 
230
<p>When a protocol emits this signal, <a href="q3networkprotocol.html" class="compat">Q3NetworkProtocol</a> is smart enough to let the <a href="q3urloperator.html" class="compat">Q3UrlOperator</a> (which is used by the network protocol) emit its corresponding signal.</p>
 
231
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/dataTransferProgress" />
180
232
<h3 class="fn"><a name="dataTransferProgress"></a>void Q3NetworkProtocol::dataTransferProgress ( int <i>bytesDone</i>, int <i>bytesTotal</i>, <a href="q3networkoperation.html">Q3NetworkOperation</a> * <i>op</i> )&nbsp;&nbsp;<tt> [signal]</tt></h3>
181
233
<p>This signal is emitted during the transfer of data (using put() or get()). <i>bytesDone</i> is how many bytes of <i>bytesTotal</i> have been transferred. <i>bytesTotal</i> may be -1, which means that the total number of bytes is not known. <i>op</i> is the pointer to the operation object which contains all the information about the operation, including the state, etc.</p>
182
 
<p>When a protocol emits this signal, <a href="q3networkprotocol.html">Q3NetworkProtocol</a> is smart enough to let the <a href="q3urloperator.html">Q3UrlOperator</a>, which is used by the network protocol, emit its corresponding signal.</p>
 
234
<p>When a protocol emits this signal, <a href="q3networkprotocol.html" class="compat">Q3NetworkProtocol</a> is smart enough to let the <a href="q3urloperator.html" class="compat">Q3UrlOperator</a>, which is used by the network protocol, emit its corresponding signal.</p>
 
235
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/finished" />
183
236
<h3 class="fn"><a name="finished"></a>void Q3NetworkProtocol::finished ( <a href="q3networkoperation.html">Q3NetworkOperation</a> * <i>op</i> )&nbsp;&nbsp;<tt> [signal]</tt></h3>
184
237
<p>This signal is emitted when an operation finishes. This signal is always emitted, for both success and failure. <i>op</i> 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>
185
 
<p>When a protocol emits this signal, <a href="q3networkprotocol.html">Q3NetworkProtocol</a> is smart enough to let the <a href="q3urloperator.html">Q3UrlOperator</a>, which is used by the network protocol, emit its corresponding signal.</p>
 
238
<p>When a protocol emits this signal, <a href="q3networkprotocol.html" class="compat">Q3NetworkProtocol</a> is smart enough to let the <a href="q3urloperator.html" class="compat">Q3UrlOperator</a>, which is used by the network protocol, emit its corresponding signal.</p>
 
239
<a name="//apple_ref/cpp/clm/Q3NetworkProtocol/getNetworkProtocol" />
186
240
<h3 class="fn"><a name="getNetworkProtocol"></a>Q3NetworkProtocol * Q3NetworkProtocol::getNetworkProtocol ( const <a href="qstring.html">QString</a> &amp; <i>protocol</i> )&nbsp;&nbsp;<tt> [static]</tt></h3>
187
241
<p>Static method to get a new instance of the network protocol <i>protocol</i>. For example, if you need to do some FTP operations, do the following:</p>
188
242
<pre> Q3Ftp *ftp = Q3NetworkProtocol::getNetworkProtocol( &quot;ftp&quot; );</pre>
189
243
<p>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>
190
 
<p>Normally you should not work directly with network protocols, so you will not need to call this method yourself. Instead, use <a href="q3urloperator.html">Q3UrlOperator</a>, which makes working with network protocols much more convenient.</p>
191
 
<p>See also <a href="q3urloperator.html">Q3UrlOperator</a>.</p>
 
244
<p>Normally you should not work directly with network protocols, so you will not need to call this method yourself. Instead, use <a href="q3urloperator.html" class="compat">Q3UrlOperator</a>, which makes working with network protocols much more convenient.</p>
 
245
<p>See also <a href="q3urloperator.html" class="compat">Q3UrlOperator</a>.</p>
 
246
<a name="//apple_ref/cpp/clm/Q3NetworkProtocol/hasOnlyLocalFileSystem" />
192
247
<h3 class="fn"><a name="hasOnlyLocalFileSystem"></a>bool Q3NetworkProtocol::hasOnlyLocalFileSystem ()&nbsp;&nbsp;<tt> [static]</tt></h3>
193
248
<p>Returns true if the only protocol registered is for working on the local filesystem; returns false if other network protocols are also registered.</p>
 
249
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/itemChanged" />
194
250
<h3 class="fn"><a name="itemChanged"></a>void Q3NetworkProtocol::itemChanged ( <a href="q3networkoperation.html">Q3NetworkOperation</a> * <i>op</i> )&nbsp;&nbsp;<tt> [signal]</tt></h3>
195
251
<p>This signal is emitted whenever a file which is a child of this URL has been changed, e.g&#x2e; by successfully calling rename(). <i>op</i> holds the original and the new file names in the first and second arguments, accessible with op-&gt;arg( 0 ) and op-&gt;arg( 1 ) respectively. <i>op</i> is the pointer to the operation object which contains all the information about the operation, including the state, etc.</p>
196
 
<p>When a protocol emits this signal, <a href="q3networkprotocol.html">Q3NetworkProtocol</a> is smart enough to let the <a href="q3urloperator.html">Q3UrlOperator</a>, which is used by the network protocol, emit its corresponding signal.</p>
 
252
<p>When a protocol emits this signal, <a href="q3networkprotocol.html" class="compat">Q3NetworkProtocol</a> is smart enough to let the <a href="q3urloperator.html" class="compat">Q3UrlOperator</a>, which is used by the network protocol, emit its corresponding signal.</p>
 
253
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/newChild" />
197
254
<h3 class="fn"><a name="newChild"></a>void Q3NetworkProtocol::newChild ( const <a href="qurlinfo.html">QUrlInfo</a> &amp; <i>i</i>, <a href="q3networkoperation.html">Q3NetworkOperation</a> * <i>op</i> )&nbsp;&nbsp;<tt> [signal]</tt></h3>
198
 
<p>This signal is emitted if a new child (file) has been read. <a href="q3networkprotocol.html">Q3NetworkProtocol</a> automatically connects it to a slot which creates a list of <a href="qurlinfo.html">QUrlInfo</a> objects (with just one <a href="qurlinfo.html">QUrlInfo</a> <i>i</i>) and emits the <a href="q3networkprotocol.html#newChildren">newChildren</a>() signal with this list. <i>op</i> is the pointer to the operation object which contains all the information about the operation that has finished, including the state, etc.</p>
 
255
<p>This signal is emitted if a new child (file) has been read. <a href="q3networkprotocol.html" class="compat">Q3NetworkProtocol</a> automatically connects it to a slot which creates a list of <a href="qurlinfo.html">QUrlInfo</a> objects (with just one <a href="qurlinfo.html">QUrlInfo</a> <i>i</i>) and emits the <a href="q3networkprotocol.html#newChildren">newChildren</a>() signal with this list. <i>op</i> is the pointer to the operation object which contains all the information about the operation that has finished, including the state, etc.</p>
199
256
<p>This is just a convenience signal useful for implementing your own network protocol. In all other cases connect to the <a href="q3networkprotocol.html#newChildren">newChildren</a>() signal with its list of <a href="qurlinfo.html">QUrlInfo</a> objects.</p>
 
257
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/newChildren" />
200
258
<h3 class="fn"><a name="newChildren"></a>void Q3NetworkProtocol::newChildren ( const <a href="q3valuelist.html">Q3ValueList</a>&lt;<a href="qurlinfo.html">QUrlInfo</a>&gt; &amp; <i>i</i>, <a href="q3networkoperation.html">Q3NetworkOperation</a> * <i>op</i> )&nbsp;&nbsp;<tt> [signal]</tt></h3>
201
259
<p>This signal is emitted after listChildren() was called and new children (files) have been read from the list of files. <i>i</i> holds the information about the new children. <i>op</i> is the pointer to the operation object which contains all the information about the operation, including the state, etc.</p>
202
 
<p>When a protocol emits this signal, <a href="q3networkprotocol.html">Q3NetworkProtocol</a> is smart enough to let the <a href="q3urloperator.html">Q3UrlOperator</a>, which is used by the network protocol, emit its corresponding signal.</p>
 
260
<p>When a protocol emits this signal, <a href="q3networkprotocol.html" class="compat">Q3NetworkProtocol</a> is smart enough to let the <a href="q3urloperator.html" class="compat">Q3UrlOperator</a>, which is used by the network protocol, emit its corresponding signal.</p>
203
261
<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">QUrlInfo</a> objects. If you prefer to read just one child at a time you can use the convenience signal <a href="q3networkprotocol.html#newChild">newChild</a>(), which takes a single <a href="qurlinfo.html">QUrlInfo</a> object.</p>
 
262
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/operationGet" />
204
263
<h3 class="fn"><a name="operationGet"></a>void Q3NetworkProtocol::operationGet ( <a href="q3networkoperation.html">Q3NetworkOperation</a> * <i>op</i> )&nbsp;&nbsp;<tt> [virtual protected]</tt></h3>
205
 
<p>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="q3networkoperation.html">Q3NetworkOperation</a>.</p>
 
264
<p>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="q3networkoperation.html" class="compat">Q3NetworkOperation</a>.</p>
206
265
<p><i>op</i> is the pointer to the operation object which contains all the information on the operation that has finished, including the state, etc.</p>
 
266
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/operationInProgress" />
207
267
<h3 class="fn"><a name="operationInProgress"></a><a href="q3networkoperation.html">Q3NetworkOperation</a> * Q3NetworkProtocol::operationInProgress () const</h3>
208
268
<p>Returns the operation, which is being processed, or 0 of no operation is being processed at the moment.</p>
 
269
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/operationListChildren" />
209
270
<h3 class="fn"><a name="operationListChildren"></a>void Q3NetworkProtocol::operationListChildren ( <a href="q3networkoperation.html">Q3NetworkOperation</a> * <i>op</i> )&nbsp;&nbsp;<tt> [virtual protected]</tt></h3>
210
 
<p>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="q3networkoperation.html">Q3NetworkOperation</a>.</p>
 
271
<p>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="q3networkoperation.html" class="compat">Q3NetworkOperation</a>.</p>
211
272
<p><i>op</i> is the pointer to the operation object which contains all the information on the operation that has finished, including the state, etc.</p>
 
273
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/operationMkDir" />
212
274
<h3 class="fn"><a name="operationMkDir"></a>void Q3NetworkProtocol::operationMkDir ( <a href="q3networkoperation.html">Q3NetworkOperation</a> * <i>op</i> )&nbsp;&nbsp;<tt> [virtual protected]</tt></h3>
213
 
<p>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="q3networkoperation.html">Q3NetworkOperation</a>.</p>
 
275
<p>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="q3networkoperation.html" class="compat">Q3NetworkOperation</a>.</p>
214
276
<p><i>op</i> is the pointer to the operation object which contains all the information on the operation that has finished, including the state, etc.</p>
 
277
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/operationPut" />
215
278
<h3 class="fn"><a name="operationPut"></a>void Q3NetworkProtocol::operationPut ( <a href="q3networkoperation.html">Q3NetworkOperation</a> * <i>op</i> )&nbsp;&nbsp;<tt> [virtual protected]</tt></h3>
216
 
<p>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="q3networkoperation.html">Q3NetworkOperation</a>.</p>
 
279
<p>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="q3networkoperation.html" class="compat">Q3NetworkOperation</a>.</p>
217
280
<p><i>op</i> is the pointer to the operation object which contains all the information on the operation that has finished, including the state, etc.</p>
 
281
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/operationRemove" />
218
282
<h3 class="fn"><a name="operationRemove"></a>void Q3NetworkProtocol::operationRemove ( <a href="q3networkoperation.html">Q3NetworkOperation</a> * <i>op</i> )&nbsp;&nbsp;<tt> [virtual protected]</tt></h3>
219
 
<p>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="q3networkoperation.html">Q3NetworkOperation</a>.</p>
 
283
<p>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="q3networkoperation.html" class="compat">Q3NetworkOperation</a>.</p>
220
284
<p><i>op</i> is the pointer to the operation object which contains all the information on the operation that has finished, including the state, etc.</p>
 
285
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/operationRename" />
221
286
<h3 class="fn"><a name="operationRename"></a>void Q3NetworkProtocol::operationRename ( <a href="q3networkoperation.html">Q3NetworkOperation</a> * <i>op</i> )&nbsp;&nbsp;<tt> [virtual protected]</tt></h3>
222
 
<p>When implementing a new network protocol, this method should be reimplemented if the protocol supports renaming children (files); this method should then process this <a href="q3networkoperation.html">Q3NetworkOperation</a>.</p>
 
287
<p>When implementing a new network protocol, this method should be reimplemented if the protocol supports renaming children (files); this method should then process this <a href="q3networkoperation.html" class="compat">Q3NetworkOperation</a>.</p>
223
288
<p><i>op</i> is the pointer to the operation object which contains all the information on the operation that has finished, including the state, etc.</p>
 
289
<a name="//apple_ref/cpp/clm/Q3NetworkProtocol/registerNetworkProtocol" />
224
290
<h3 class="fn"><a name="registerNetworkProtocol"></a>void Q3NetworkProtocol::registerNetworkProtocol ( const <a href="qstring.html">QString</a> &amp; <i>protocol</i>, Q3NetworkProtocolFactoryBase * <i>protocolFactory</i> )&nbsp;&nbsp;<tt> [static]</tt></h3>
225
 
<p>Static method to register a network protocol for Qt. For example, if you have an implementation of NNTP (called Nntp) which is derived from <a href="q3networkprotocol.html">Q3NetworkProtocol</a>, call:</p>
 
291
<p>Static method to register a network protocol for Qt. For example, if you have an implementation of NNTP (called Nntp) which is derived from <a href="q3networkprotocol.html" class="compat">Q3NetworkProtocol</a>, call:</p>
226
292
<pre> Q3NetworkProtocol::registerNetworkProtocol( &quot;nntp&quot;, new Q3NetworkProtocolFactory&lt;Nntp&gt; );</pre>
227
293
<p>after which your implementation is registered for future nntp operations.</p>
228
294
<p>The name of the protocol is given in <i>protocol</i> and a pointer to the protocol factory is given in <i>protocolFactory</i>.</p>
 
295
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/removed" />
229
296
<h3 class="fn"><a name="removed"></a>void Q3NetworkProtocol::removed ( <a href="q3networkoperation.html">Q3NetworkOperation</a> * <i>op</i> )&nbsp;&nbsp;<tt> [signal]</tt></h3>
230
297
<p>This signal is emitted when remove() has been succesiisful and the file has been removed. <i>op</i> holds the file name of the removed file in the first argument, accessible with op-&gt;arg( 0 ). <i>op</i> is the pointer to the operation object which contains all the information about the operation, including the state, etc.</p>
231
 
<p>When a protocol emits this signal, <a href="q3networkprotocol.html">Q3NetworkProtocol</a> is smart enough to let the <a href="q3urloperator.html">Q3UrlOperator</a>, which is used by the network protocol, emit its corresponding signal.</p>
 
298
<p>When a protocol emits this signal, <a href="q3networkprotocol.html" class="compat">Q3NetworkProtocol</a> is smart enough to let the <a href="q3urloperator.html" class="compat">Q3UrlOperator</a>, which is used by the network protocol, emit its corresponding signal.</p>
 
299
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/setAutoDelete" />
232
300
<h3 class="fn"><a name="setAutoDelete"></a>void Q3NetworkProtocol::setAutoDelete ( bool <i>b</i>, int <i>i</i> = 10000 )&nbsp;&nbsp;<tt> [virtual]</tt></h3>
233
 
<p>Because it's sometimes hard to take care of removing network protocol instances, <a href="q3networkprotocol.html">Q3NetworkProtocol</a> provides an auto-delete mechanism. If you set <i>b</i> to true, the network protocol instance is removed after it has been inactive for <i>i</i> milliseconds (i.e&#x2e; <i>i</i> milliseconds after the last operation has been processed). If you set <i>b</i> to false the auto-delete mechanism is switched off.</p>
234
 
<p>If you switch on auto-delete, the <a href="q3networkprotocol.html">Q3NetworkProtocol</a> also deletes its <a href="q3urloperator.html">Q3UrlOperator</a>.</p>
 
301
<p>Because it's sometimes hard to take care of removing network protocol instances, <a href="q3networkprotocol.html" class="compat">Q3NetworkProtocol</a> provides an auto-delete mechanism. If you set <i>b</i> to true, the network protocol instance is removed after it has been inactive for <i>i</i> milliseconds (i.e&#x2e; <i>i</i> milliseconds after the last operation has been processed). If you set <i>b</i> to false the auto-delete mechanism is switched off.</p>
 
302
<p>If you switch on auto-delete, the <a href="q3networkprotocol.html" class="compat">Q3NetworkProtocol</a> also deletes its <a href="q3urloperator.html" class="compat">Q3UrlOperator</a>.</p>
235
303
<p>See also <a href="q3networkprotocol.html#autoDelete">autoDelete</a>().</p>
 
304
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/setUrl" />
236
305
<h3 class="fn"><a name="setUrl"></a>void Q3NetworkProtocol::setUrl ( <a href="q3urloperator.html">Q3UrlOperator</a> * <i>u</i> )&nbsp;&nbsp;<tt> [virtual]</tt></h3>
237
 
<p>Sets the <a href="q3urloperator.html">Q3UrlOperator</a>, on which the protocol works, to <i>u</i>.</p>
238
 
<p>See also <a href="q3networkprotocol.html#url">url</a>() and <a href="q3urloperator.html">Q3UrlOperator</a>.</p>
 
306
<p>Sets the <a href="q3urloperator.html" class="compat">Q3UrlOperator</a>, on which the protocol works, to <i>u</i>.</p>
 
307
<p>See also <a href="q3networkprotocol.html#url">url</a>() and <a href="q3urloperator.html" class="compat">Q3UrlOperator</a>.</p>
 
308
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/start" />
239
309
<h3 class="fn"><a name="start"></a>void Q3NetworkProtocol::start ( <a href="q3networkoperation.html">Q3NetworkOperation</a> * <i>op</i> )&nbsp;&nbsp;<tt> [signal]</tt></h3>
240
310
<p>Some operations (such as listChildren()) emit this signal when they start processing the operation. <i>op</i> is the pointer to the operation object which contains all the information about the operation, including the state, etc.</p>
241
 
<p>When a protocol emits this signal, <a href="q3networkprotocol.html">Q3NetworkProtocol</a> is smart enough to let the <a href="q3urloperator.html">Q3UrlOperator</a>, which is used by the network protocol, emit its corresponding signal.</p>
 
311
<p>When a protocol emits this signal, <a href="q3networkprotocol.html" class="compat">Q3NetworkProtocol</a> is smart enough to let the <a href="q3urloperator.html" class="compat">Q3UrlOperator</a>, which is used by the network protocol, emit its corresponding signal.</p>
 
312
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/stop" />
242
313
<h3 class="fn"><a name="stop"></a>void Q3NetworkProtocol::stop ()&nbsp;&nbsp;<tt> [virtual]</tt></h3>
243
314
<p>Stops the current operation that is being processed and clears all waiting operations.</p>
 
315
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/supportedOperations" />
244
316
<h3 class="fn"><a name="supportedOperations"></a>int Q3NetworkProtocol::supportedOperations () const&nbsp;&nbsp;<tt> [virtual]</tt></h3>
245
317
<p>Returns an int that is OR'd together using the enum values of <a href="q3networkprotocol.html#Operation-enum">Q3NetworkProtocol::Operation</a>, which describes which operations are supported by the network protocol. Should be reimplemented by new network protocols.</p>
 
318
<a name="//apple_ref/cpp/instm/Q3NetworkProtocol/url" />
246
319
<h3 class="fn"><a name="url"></a><a href="q3urloperator.html">Q3UrlOperator</a> * Q3NetworkProtocol::url () const</h3>
247
 
<p>Returns the <a href="q3urloperator.html">Q3UrlOperator</a> on which the protocol works.</p>
 
320
<p>Returns the <a href="q3urloperator.html" class="compat">Q3UrlOperator</a> on which the protocol works.</p>
248
321
<p>See also <a href="q3networkprotocol.html#setUrl">setUrl</a>().</p>
249
322
<p /><address><hr /><div align="center">
250
323
<table width="100%" cellspacing="0" border="0"><tr class="address">
251
 
<td width="30%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
252
 
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
253
 
<td width="30%" align="right"><div align="right">Qt 4.5.2</div></td>
254
 
</tr></table></div></address></body>
 
324
<td width="40%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
 
325
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
 
326
<td width="40%" align="right"><div align="right">Qt 4.6.0</div></td>
 
327
<script type="text/javascript" src="http://www.google.com/jsapi"></script><script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script><script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en"></script><script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script></tr></table></div></address></body>
255
328
</html>