eric6/Documentation/Source/eric6.Helpviewer.Network.FtpReply.html

branch
maintenance
changeset 7286
7eb04391adf7
parent 7226
babe80d84a3e
parent 7285
1ff497f33f31
child 7287
1c17f2191bdd
equal deleted inserted replaced
7226:babe80d84a3e 7286:7eb04391adf7
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.Network.FtpReply</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.Helpviewer.Network.FtpReply</h1>
23 <p>
24 Module implementing a network reply class for FTP resources.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>ftpListPage_html</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#FtpReply">FtpReply</a></td>
34 <td>Class implementing a network reply for FTP resources.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="FtpReply" ID="FtpReply"></a>
43 <h2>FtpReply</h2>
44 <p>
45 Class implementing a network reply for FTP resources.
46 </p>
47 <h3>Derived from</h3>
48 QNetworkReply
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#FtpReply.__init__">FtpReply</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#FtpReply.__cssLinkClass">__cssLinkClass</a></td>
64 <td>Private method to generate a link class with an icon.</td>
65 </tr><tr>
66 <td><a href="#FtpReply.__dirCallback">__dirCallback</a></td>
67 <td>Private slot handling the receipt of directory listings.</td>
68 </tr><tr>
69 <td><a href="#FtpReply.__doFtpCommands">__doFtpCommands</a></td>
70 <td>Private slot doing the sequence of FTP commands to get the requested result.</td>
71 </tr><tr>
72 <td><a href="#FtpReply.__doFtpLogin">__doFtpLogin</a></td>
73 <td>Private method to do the FTP login with asking for a username and password, if the login fails with an error 530.</td>
74 </tr><tr>
75 <td><a href="#FtpReply.__retrCallback">__retrCallback</a></td>
76 <td>Private slot handling the reception of data.</td>
77 </tr><tr>
78 <td><a href="#FtpReply.__setContent">__setContent</a></td>
79 <td>Private method to finish the setup of the data.</td>
80 </tr><tr>
81 <td><a href="#FtpReply.__setListContent">__setListContent</a></td>
82 <td>Private method to prepare the content for the reader.</td>
83 </tr><tr>
84 <td><a href="#FtpReply.abort">abort</a></td>
85 <td>Public slot to abort the operation.</td>
86 </tr><tr>
87 <td><a href="#FtpReply.bytesAvailable">bytesAvailable</a></td>
88 <td>Public method to determined the bytes available for being read.</td>
89 </tr><tr>
90 <td><a href="#FtpReply.isSequential">isSequential</a></td>
91 <td>Public method to check for sequential access.</td>
92 </tr><tr>
93 <td><a href="#FtpReply.readData">readData</a></td>
94 <td>Public method to retrieve data from the reply object.</td>
95 </tr>
96 </table>
97 <h3>Static Methods</h3>
98 <table>
99 <tr><td>None</td></tr>
100 </table>
101 <a NAME="FtpReply.__init__" ID="FtpReply.__init__"></a>
102 <h4>FtpReply (Constructor)</h4>
103 <b>FtpReply</b>(<i>url, accessHandler, parent=None</i>)
104 <p>
105 Constructor
106 </p><dl>
107 <dt><i>url</i></dt>
108 <dd>
109 requested FTP URL (QUrl)
110 </dd><dt><i>accessHandler</i></dt>
111 <dd>
112 reference to the access handler (FtpAccessHandler)
113 </dd><dt><i>parent</i></dt>
114 <dd>
115 reference to the parent object (QObject)
116 </dd>
117 </dl><a NAME="FtpReply.__cssLinkClass" ID="FtpReply.__cssLinkClass"></a>
118 <h4>FtpReply.__cssLinkClass</h4>
119 <b>__cssLinkClass</b>(<i>icon, size=32</i>)
120 <p>
121 Private method to generate a link class with an icon.
122 </p><dl>
123 <dt><i>icon</i></dt>
124 <dd>
125 icon to be included (QIcon)
126 </dd><dt><i>size</i></dt>
127 <dd>
128 size of the icon to be generated (integer)
129 </dd>
130 </dl><dl>
131 <dt>Returns:</dt>
132 <dd>
133 CSS class string (string)
134 </dd>
135 </dl><a NAME="FtpReply.__dirCallback" ID="FtpReply.__dirCallback"></a>
136 <h4>FtpReply.__dirCallback</h4>
137 <b>__dirCallback</b>(<i>line</i>)
138 <p>
139 Private slot handling the receipt of directory listings.
140 </p><dl>
141 <dt><i>line</i></dt>
142 <dd>
143 the received line of the directory listing (string)
144 </dd>
145 </dl><a NAME="FtpReply.__doFtpCommands" ID="FtpReply.__doFtpCommands"></a>
146 <h4>FtpReply.__doFtpCommands</h4>
147 <b>__doFtpCommands</b>(<i></i>)
148 <p>
149 Private slot doing the sequence of FTP commands to get the requested
150 result.
151 </p><a NAME="FtpReply.__doFtpLogin" ID="FtpReply.__doFtpLogin"></a>
152 <h4>FtpReply.__doFtpLogin</h4>
153 <b>__doFtpLogin</b>(<i>username, password, byAuth=False</i>)
154 <p>
155 Private method to do the FTP login with asking for a username and
156 password, if the login fails with an error 530.
157 </p><dl>
158 <dt><i>username</i></dt>
159 <dd>
160 user name to use for the login (string)
161 </dd><dt><i>password</i></dt>
162 <dd>
163 password to use for the login (string)
164 </dd><dt><i>byAuth</i></dt>
165 <dd>
166 flag indicating that the login data was provided by an
167 authenticator (boolean)
168 </dd>
169 </dl><dl>
170 <dt>Returns:</dt>
171 <dd>
172 tuple of two flags indicating a successful login and
173 if the login should be retried (boolean, boolean)
174 </dd>
175 </dl><a NAME="FtpReply.__retrCallback" ID="FtpReply.__retrCallback"></a>
176 <h4>FtpReply.__retrCallback</h4>
177 <b>__retrCallback</b>(<i>data</i>)
178 <p>
179 Private slot handling the reception of data.
180 </p><dl>
181 <dt><i>data</i></dt>
182 <dd>
183 data received from the FTP server (bytes)
184 </dd>
185 </dl><a NAME="FtpReply.__setContent" ID="FtpReply.__setContent"></a>
186 <h4>FtpReply.__setContent</h4>
187 <b>__setContent</b>(<i></i>)
188 <p>
189 Private method to finish the setup of the data.
190 </p><a NAME="FtpReply.__setListContent" ID="FtpReply.__setListContent"></a>
191 <h4>FtpReply.__setListContent</h4>
192 <b>__setListContent</b>(<i></i>)
193 <p>
194 Private method to prepare the content for the reader.
195 </p><a NAME="FtpReply.abort" ID="FtpReply.abort"></a>
196 <h4>FtpReply.abort</h4>
197 <b>abort</b>(<i></i>)
198 <p>
199 Public slot to abort the operation.
200 </p><a NAME="FtpReply.bytesAvailable" ID="FtpReply.bytesAvailable"></a>
201 <h4>FtpReply.bytesAvailable</h4>
202 <b>bytesAvailable</b>(<i></i>)
203 <p>
204 Public method to determined the bytes available for being read.
205 </p><dl>
206 <dt>Returns:</dt>
207 <dd>
208 bytes available (integer)
209 </dd>
210 </dl><a NAME="FtpReply.isSequential" ID="FtpReply.isSequential"></a>
211 <h4>FtpReply.isSequential</h4>
212 <b>isSequential</b>(<i></i>)
213 <p>
214 Public method to check for sequential access.
215 </p><dl>
216 <dt>Returns:</dt>
217 <dd>
218 flag indicating sequential access (boolean)
219 </dd>
220 </dl><a NAME="FtpReply.readData" ID="FtpReply.readData"></a>
221 <h4>FtpReply.readData</h4>
222 <b>readData</b>(<i>maxlen</i>)
223 <p>
224 Public method to retrieve data from the reply object.
225 </p><dl>
226 <dt><i>maxlen</i></dt>
227 <dd>
228 maximum number of bytes to read (integer)
229 </dd>
230 </dl><dl>
231 <dt>Returns:</dt>
232 <dd>
233 string containing the data (bytes)
234 </dd>
235 </dl>
236 <div align="right"><a href="#top">Up</a></div>
237 <hr />
238 </body></html>

eric ide

mercurial