Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.Sync.FtpSyncHandler.html
src/eric7/Documentation/Source/eric7.WebBrowser.Sync.FtpSyncHandler.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 10436
- f6881d10e995
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.WebBrowser.Sync.FtpSyncHandler</h1> | 9 <h1>eric7.WebBrowser.Sync.FtpSyncHandler</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing a synchronization handler using FTP. | 11 Module implementing a synchronization handler using FTP. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | |
| 16 <table> | 15 <table> |
| 17 <tr><td>None</td></tr> | 16 <tr><td>None</td></tr> |
| 18 </table> | 17 </table> |
| 18 | |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | 20 <table> |
| 21 <table> | |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#FtpSyncHandler">FtpSyncHandler</a></td> | 22 <td><a href="#FtpSyncHandler">FtpSyncHandler</a></td> |
| 25 <td>Class implementing a synchronization handler using FTP.</td> | 23 <td>Class implementing a synchronization handler using FTP.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | |
| 30 <table> | 28 <table> |
| 31 <tr><td>None</td></tr> | 29 <tr><td>None</td></tr> |
| 32 </table> | 30 </table> |
| 31 | |
| 33 <hr /> | 32 <hr /> |
| 34 <hr /> | 33 <hr /> |
| 35 <a NAME="FtpSyncHandler" ID="FtpSyncHandler"></a> | 34 <a NAME="FtpSyncHandler" ID="FtpSyncHandler"></a> |
| 36 <h2>FtpSyncHandler</h2> | 35 <h2>FtpSyncHandler</h2> |
| 37 | |
| 38 <p> | 36 <p> |
| 39 Class implementing a synchronization handler using FTP. | 37 Class implementing a synchronization handler using FTP. |
| 40 </p> | 38 </p> |
| 39 | |
| 41 <h3>Signals</h3> | 40 <h3>Signals</h3> |
| 42 <dl> | 41 <dl> |
| 43 | 42 |
| 44 <dt>syncError(message)</dt> | 43 <dt>syncError(message)</dt> |
| 45 <dd> | 44 <dd> |
| 60 </dd> | 59 </dd> |
| 61 </dl> | 60 </dl> |
| 62 <h3>Derived from</h3> | 61 <h3>Derived from</h3> |
| 63 SyncHandler | 62 SyncHandler |
| 64 <h3>Class Attributes</h3> | 63 <h3>Class Attributes</h3> |
| 65 | |
| 66 <table> | 64 <table> |
| 67 <tr><td>None</td></tr> | 65 <tr><td>None</td></tr> |
| 68 </table> | 66 </table> |
| 67 | |
| 69 <h3>Class Methods</h3> | 68 <h3>Class Methods</h3> |
| 70 | |
| 71 <table> | 69 <table> |
| 72 <tr><td>None</td></tr> | 70 <tr><td>None</td></tr> |
| 73 </table> | 71 </table> |
| 72 | |
| 74 <h3>Methods</h3> | 73 <h3>Methods</h3> |
| 75 | 74 <table> |
| 76 <table> | |
| 77 | |
| 78 <tr> | 75 <tr> |
| 79 <td><a href="#FtpSyncHandler.__init__">FtpSyncHandler</a></td> | 76 <td><a href="#FtpSyncHandler.__init__">FtpSyncHandler</a></td> |
| 80 <td>Constructor</td> | 77 <td>Constructor</td> |
| 81 </tr> | 78 </tr> |
| 82 <tr> | 79 <tr> |
| 150 <tr> | 147 <tr> |
| 151 <td><a href="#FtpSyncHandler.syncUserAgents">syncUserAgents</a></td> | 148 <td><a href="#FtpSyncHandler.syncUserAgents">syncUserAgents</a></td> |
| 152 <td>Public method to synchronize the user agents.</td> | 149 <td>Public method to synchronize the user agents.</td> |
| 153 </tr> | 150 </tr> |
| 154 </table> | 151 </table> |
| 152 | |
| 155 <h3>Static Methods</h3> | 153 <h3>Static Methods</h3> |
| 156 | |
| 157 <table> | 154 <table> |
| 158 <tr><td>None</td></tr> | 155 <tr><td>None</td></tr> |
| 159 </table> | 156 </table> |
| 157 | |
| 160 | 158 |
| 161 <a NAME="FtpSyncHandler.__init__" ID="FtpSyncHandler.__init__"></a> | 159 <a NAME="FtpSyncHandler.__init__" ID="FtpSyncHandler.__init__"></a> |
| 162 <h4>FtpSyncHandler (Constructor)</h4> | 160 <h4>FtpSyncHandler (Constructor)</h4> |
| 163 <b>FtpSyncHandler</b>(<i>parent=None</i>) | 161 <b>FtpSyncHandler</b>(<i>parent=None</i>) |
| 164 | |
| 165 <p> | 162 <p> |
| 166 Constructor | 163 Constructor |
| 167 </p> | 164 </p> |
| 165 | |
| 168 <dl> | 166 <dl> |
| 169 | 167 |
| 170 <dt><i>parent</i> (QObject)</dt> | 168 <dt><i>parent</i> (QObject)</dt> |
| 171 <dd> | 169 <dd> |
| 172 reference to the parent object | 170 reference to the parent object |
| 173 </dd> | 171 </dd> |
| 174 </dl> | 172 </dl> |
| 175 <a NAME="FtpSyncHandler.__changeToStore" ID="FtpSyncHandler.__changeToStore"></a> | 173 <a NAME="FtpSyncHandler.__changeToStore" ID="FtpSyncHandler.__changeToStore"></a> |
| 176 <h4>FtpSyncHandler.__changeToStore</h4> | 174 <h4>FtpSyncHandler.__changeToStore</h4> |
| 177 <b>__changeToStore</b>(<i></i>) | 175 <b>__changeToStore</b>(<i></i>) |
| 178 | |
| 179 <p> | 176 <p> |
| 180 Private slot to change to the storage directory. | 177 Private slot to change to the storage directory. |
| 181 </p> | 178 </p> |
| 182 <p> | 179 <p> |
| 183 This action will create the storage path on the server, if it | 180 This action will create the storage path on the server, if it |
| 184 does not exist. Upon return, the current directory of the server | 181 does not exist. Upon return, the current directory of the server |
| 185 is the sync directory. | 182 is the sync directory. |
| 186 </p> | 183 </p> |
| 184 | |
| 187 <a NAME="FtpSyncHandler.__connectAndLogin" ID="FtpSyncHandler.__connectAndLogin"></a> | 185 <a NAME="FtpSyncHandler.__connectAndLogin" ID="FtpSyncHandler.__connectAndLogin"></a> |
| 188 <h4>FtpSyncHandler.__connectAndLogin</h4> | 186 <h4>FtpSyncHandler.__connectAndLogin</h4> |
| 189 <b>__connectAndLogin</b>(<i></i>) | 187 <b>__connectAndLogin</b>(<i></i>) |
| 190 | |
| 191 <p> | 188 <p> |
| 192 Private method to connect to the FTP server and log in. | 189 Private method to connect to the FTP server and log in. |
| 193 </p> | 190 </p> |
| 191 | |
| 194 <dl> | 192 <dl> |
| 195 <dt>Return:</dt> | 193 <dt>Return:</dt> |
| 196 <dd> | 194 <dd> |
| 197 flag indicating a successful log in | 195 flag indicating a successful log in |
| 198 </dd> | 196 </dd> |
| 204 </dd> | 202 </dd> |
| 205 </dl> | 203 </dl> |
| 206 <a NAME="FtpSyncHandler.__dirListCallback" ID="FtpSyncHandler.__dirListCallback"></a> | 204 <a NAME="FtpSyncHandler.__dirListCallback" ID="FtpSyncHandler.__dirListCallback"></a> |
| 207 <h4>FtpSyncHandler.__dirListCallback</h4> | 205 <h4>FtpSyncHandler.__dirListCallback</h4> |
| 208 <b>__dirListCallback</b>(<i>line</i>) | 206 <b>__dirListCallback</b>(<i>line</i>) |
| 209 | |
| 210 <p> | 207 <p> |
| 211 Private slot handling the receipt of directory listing lines. | 208 Private slot handling the receipt of directory listing lines. |
| 212 </p> | 209 </p> |
| 210 | |
| 213 <dl> | 211 <dl> |
| 214 | 212 |
| 215 <dt><i>line</i> (str)</dt> | 213 <dt><i>line</i> (str)</dt> |
| 216 <dd> | 214 <dd> |
| 217 the received line of the directory listing | 215 the received line of the directory listing |
| 218 </dd> | 216 </dd> |
| 219 </dl> | 217 </dl> |
| 220 <a NAME="FtpSyncHandler.__doFtpCommands" ID="FtpSyncHandler.__doFtpCommands"></a> | 218 <a NAME="FtpSyncHandler.__doFtpCommands" ID="FtpSyncHandler.__doFtpCommands"></a> |
| 221 <h4>FtpSyncHandler.__doFtpCommands</h4> | 219 <h4>FtpSyncHandler.__doFtpCommands</h4> |
| 222 <b>__doFtpCommands</b>(<i></i>) | 220 <b>__doFtpCommands</b>(<i></i>) |
| 223 | |
| 224 <p> | 221 <p> |
| 225 Private slot executing the sequence of FTP commands. | 222 Private slot executing the sequence of FTP commands. |
| 226 </p> | 223 </p> |
| 224 | |
| 227 <a NAME="FtpSyncHandler.__downloadFile" ID="FtpSyncHandler.__downloadFile"></a> | 225 <a NAME="FtpSyncHandler.__downloadFile" ID="FtpSyncHandler.__downloadFile"></a> |
| 228 <h4>FtpSyncHandler.__downloadFile</h4> | 226 <h4>FtpSyncHandler.__downloadFile</h4> |
| 229 <b>__downloadFile</b>(<i>type_, fileName, timestamp</i>) | 227 <b>__downloadFile</b>(<i>type_, fileName, timestamp</i>) |
| 230 | |
| 231 <p> | 228 <p> |
| 232 Private method to downlaod the given file. | 229 Private method to downlaod the given file. |
| 233 </p> | 230 </p> |
| 231 | |
| 234 <dl> | 232 <dl> |
| 235 | 233 |
| 236 <dt><i>type_</i> (str)</dt> | 234 <dt><i>type_</i> (str)</dt> |
| 237 <dd> | 235 <dd> |
| 238 type of the synchronization event (one of | 236 type of the synchronization event (one of |
| 248 </dd> | 246 </dd> |
| 249 </dl> | 247 </dl> |
| 250 <a NAME="FtpSyncHandler.__downloadFileCallback" ID="FtpSyncHandler.__downloadFileCallback"></a> | 248 <a NAME="FtpSyncHandler.__downloadFileCallback" ID="FtpSyncHandler.__downloadFileCallback"></a> |
| 251 <h4>FtpSyncHandler.__downloadFileCallback</h4> | 249 <h4>FtpSyncHandler.__downloadFileCallback</h4> |
| 252 <b>__downloadFileCallback</b>(<i>buffer, data</i>) | 250 <b>__downloadFileCallback</b>(<i>buffer, data</i>) |
| 253 | |
| 254 <p> | 251 <p> |
| 255 Private method receiving the downloaded data. | 252 Private method receiving the downloaded data. |
| 256 </p> | 253 </p> |
| 254 | |
| 257 <dl> | 255 <dl> |
| 258 | 256 |
| 259 <dt><i>buffer</i> (io.BytesIO)</dt> | 257 <dt><i>buffer</i> (io.BytesIO)</dt> |
| 260 <dd> | 258 <dd> |
| 261 reference to the buffer | 259 reference to the buffer |
| 278 </dd> | 276 </dd> |
| 279 </dl> | 277 </dl> |
| 280 <a NAME="FtpSyncHandler.__idleTimeout" ID="FtpSyncHandler.__idleTimeout"></a> | 278 <a NAME="FtpSyncHandler.__idleTimeout" ID="FtpSyncHandler.__idleTimeout"></a> |
| 281 <h4>FtpSyncHandler.__idleTimeout</h4> | 279 <h4>FtpSyncHandler.__idleTimeout</h4> |
| 282 <b>__idleTimeout</b>(<i></i>) | 280 <b>__idleTimeout</b>(<i></i>) |
| 283 | |
| 284 <p> | 281 <p> |
| 285 Private slot to prevent a disconnect from the server. | 282 Private slot to prevent a disconnect from the server. |
| 286 </p> | 283 </p> |
| 284 | |
| 287 <a NAME="FtpSyncHandler.__initialSync" ID="FtpSyncHandler.__initialSync"></a> | 285 <a NAME="FtpSyncHandler.__initialSync" ID="FtpSyncHandler.__initialSync"></a> |
| 288 <h4>FtpSyncHandler.__initialSync</h4> | 286 <h4>FtpSyncHandler.__initialSync</h4> |
| 289 <b>__initialSync</b>(<i></i>) | 287 <b>__initialSync</b>(<i></i>) |
| 290 | |
| 291 <p> | 288 <p> |
| 292 Private slot to do the initial synchronization. | 289 Private slot to do the initial synchronization. |
| 293 </p> | 290 </p> |
| 291 | |
| 294 <a NAME="FtpSyncHandler.__initialSyncFile" ID="FtpSyncHandler.__initialSyncFile"></a> | 292 <a NAME="FtpSyncHandler.__initialSyncFile" ID="FtpSyncHandler.__initialSyncFile"></a> |
| 295 <h4>FtpSyncHandler.__initialSyncFile</h4> | 293 <h4>FtpSyncHandler.__initialSyncFile</h4> |
| 296 <b>__initialSyncFile</b>(<i>type_, fileName</i>) | 294 <b>__initialSyncFile</b>(<i>type_, fileName</i>) |
| 297 | |
| 298 <p> | 295 <p> |
| 299 Private method to do the initial synchronization of the given file. | 296 Private method to do the initial synchronization of the given file. |
| 300 </p> | 297 </p> |
| 298 | |
| 301 <dl> | 299 <dl> |
| 302 | 300 |
| 303 <dt><i>type_</i> (str)</dt> | 301 <dt><i>type_</i> (str)</dt> |
| 304 <dd> | 302 <dd> |
| 305 type of the synchronization event (one of "bookmarks", | 303 type of the synchronization event (one of "bookmarks", |
| 311 </dd> | 309 </dd> |
| 312 </dl> | 310 </dl> |
| 313 <a NAME="FtpSyncHandler.__syncFile" ID="FtpSyncHandler.__syncFile"></a> | 311 <a NAME="FtpSyncHandler.__syncFile" ID="FtpSyncHandler.__syncFile"></a> |
| 314 <h4>FtpSyncHandler.__syncFile</h4> | 312 <h4>FtpSyncHandler.__syncFile</h4> |
| 315 <b>__syncFile</b>(<i>type_, fileName</i>) | 313 <b>__syncFile</b>(<i>type_, fileName</i>) |
| 316 | |
| 317 <p> | 314 <p> |
| 318 Private method to synchronize the given file. | 315 Private method to synchronize the given file. |
| 319 </p> | 316 </p> |
| 317 | |
| 320 <dl> | 318 <dl> |
| 321 | 319 |
| 322 <dt><i>type_</i> (str)</dt> | 320 <dt><i>type_</i> (str)</dt> |
| 323 <dd> | 321 <dd> |
| 324 type of the synchronization event (one of "bookmarks", | 322 type of the synchronization event (one of "bookmarks", |
| 330 </dd> | 328 </dd> |
| 331 </dl> | 329 </dl> |
| 332 <a NAME="FtpSyncHandler.__uploadFile" ID="FtpSyncHandler.__uploadFile"></a> | 330 <a NAME="FtpSyncHandler.__uploadFile" ID="FtpSyncHandler.__uploadFile"></a> |
| 333 <h4>FtpSyncHandler.__uploadFile</h4> | 331 <h4>FtpSyncHandler.__uploadFile</h4> |
| 334 <b>__uploadFile</b>(<i>type_, fileName</i>) | 332 <b>__uploadFile</b>(<i>type_, fileName</i>) |
| 335 | |
| 336 <p> | 333 <p> |
| 337 Private method to upload the given file. | 334 Private method to upload the given file. |
| 338 </p> | 335 </p> |
| 336 | |
| 339 <dl> | 337 <dl> |
| 340 | 338 |
| 341 <dt><i>type_</i> (str)</dt> | 339 <dt><i>type_</i> (str)</dt> |
| 342 <dd> | 340 <dd> |
| 343 type of the synchronization event (one of "bookmarks", | 341 type of the synchronization event (one of "bookmarks", |
| 361 </dd> | 359 </dd> |
| 362 </dl> | 360 </dl> |
| 363 <a NAME="FtpSyncHandler.initialLoadAndCheck" ID="FtpSyncHandler.initialLoadAndCheck"></a> | 361 <a NAME="FtpSyncHandler.initialLoadAndCheck" ID="FtpSyncHandler.initialLoadAndCheck"></a> |
| 364 <h4>FtpSyncHandler.initialLoadAndCheck</h4> | 362 <h4>FtpSyncHandler.initialLoadAndCheck</h4> |
| 365 <b>initialLoadAndCheck</b>(<i>forceUpload</i>) | 363 <b>initialLoadAndCheck</b>(<i>forceUpload</i>) |
| 366 | |
| 367 <p> | 364 <p> |
| 368 Public method to do the initial check. | 365 Public method to do the initial check. |
| 369 </p> | 366 </p> |
| 367 | |
| 370 <dl> | 368 <dl> |
| 371 | 369 |
| 372 <dt><i>forceUpload</i> (bool)</dt> | 370 <dt><i>forceUpload</i> (bool)</dt> |
| 373 <dd> | 371 <dd> |
| 374 flag indicating a forced upload of the files | 372 flag indicating a forced upload of the files |
| 375 </dd> | 373 </dd> |
| 376 </dl> | 374 </dl> |
| 377 <a NAME="FtpSyncHandler.shutdown" ID="FtpSyncHandler.shutdown"></a> | 375 <a NAME="FtpSyncHandler.shutdown" ID="FtpSyncHandler.shutdown"></a> |
| 378 <h4>FtpSyncHandler.shutdown</h4> | 376 <h4>FtpSyncHandler.shutdown</h4> |
| 379 <b>shutdown</b>(<i></i>) | 377 <b>shutdown</b>(<i></i>) |
| 380 | |
| 381 <p> | 378 <p> |
| 382 Public method to shut down the handler. | 379 Public method to shut down the handler. |
| 383 </p> | 380 </p> |
| 381 | |
| 384 <a NAME="FtpSyncHandler.syncBookmarks" ID="FtpSyncHandler.syncBookmarks"></a> | 382 <a NAME="FtpSyncHandler.syncBookmarks" ID="FtpSyncHandler.syncBookmarks"></a> |
| 385 <h4>FtpSyncHandler.syncBookmarks</h4> | 383 <h4>FtpSyncHandler.syncBookmarks</h4> |
| 386 <b>syncBookmarks</b>(<i></i>) | 384 <b>syncBookmarks</b>(<i></i>) |
| 387 | |
| 388 <p> | 385 <p> |
| 389 Public method to synchronize the bookmarks. | 386 Public method to synchronize the bookmarks. |
| 390 </p> | 387 </p> |
| 388 | |
| 391 <a NAME="FtpSyncHandler.syncHistory" ID="FtpSyncHandler.syncHistory"></a> | 389 <a NAME="FtpSyncHandler.syncHistory" ID="FtpSyncHandler.syncHistory"></a> |
| 392 <h4>FtpSyncHandler.syncHistory</h4> | 390 <h4>FtpSyncHandler.syncHistory</h4> |
| 393 <b>syncHistory</b>(<i></i>) | 391 <b>syncHistory</b>(<i></i>) |
| 394 | |
| 395 <p> | 392 <p> |
| 396 Public method to synchronize the history. | 393 Public method to synchronize the history. |
| 397 </p> | 394 </p> |
| 395 | |
| 398 <a NAME="FtpSyncHandler.syncPasswords" ID="FtpSyncHandler.syncPasswords"></a> | 396 <a NAME="FtpSyncHandler.syncPasswords" ID="FtpSyncHandler.syncPasswords"></a> |
| 399 <h4>FtpSyncHandler.syncPasswords</h4> | 397 <h4>FtpSyncHandler.syncPasswords</h4> |
| 400 <b>syncPasswords</b>(<i></i>) | 398 <b>syncPasswords</b>(<i></i>) |
| 401 | |
| 402 <p> | 399 <p> |
| 403 Public method to synchronize the passwords. | 400 Public method to synchronize the passwords. |
| 404 </p> | 401 </p> |
| 402 | |
| 405 <a NAME="FtpSyncHandler.syncSpeedDial" ID="FtpSyncHandler.syncSpeedDial"></a> | 403 <a NAME="FtpSyncHandler.syncSpeedDial" ID="FtpSyncHandler.syncSpeedDial"></a> |
| 406 <h4>FtpSyncHandler.syncSpeedDial</h4> | 404 <h4>FtpSyncHandler.syncSpeedDial</h4> |
| 407 <b>syncSpeedDial</b>(<i></i>) | 405 <b>syncSpeedDial</b>(<i></i>) |
| 408 | |
| 409 <p> | 406 <p> |
| 410 Public method to synchronize the speed dial data. | 407 Public method to synchronize the speed dial data. |
| 411 </p> | 408 </p> |
| 409 | |
| 412 <a NAME="FtpSyncHandler.syncUserAgents" ID="FtpSyncHandler.syncUserAgents"></a> | 410 <a NAME="FtpSyncHandler.syncUserAgents" ID="FtpSyncHandler.syncUserAgents"></a> |
| 413 <h4>FtpSyncHandler.syncUserAgents</h4> | 411 <h4>FtpSyncHandler.syncUserAgents</h4> |
| 414 <b>syncUserAgents</b>(<i></i>) | 412 <b>syncUserAgents</b>(<i></i>) |
| 415 | |
| 416 <p> | 413 <p> |
| 417 Public method to synchronize the user agents. | 414 Public method to synchronize the user agents. |
| 418 </p> | 415 </p> |
| 416 | |
| 419 <div align="right"><a href="#top">Up</a></div> | 417 <div align="right"><a href="#top">Up</a></div> |
| 420 <hr /> | 418 <hr /> |
| 421 </body></html> | 419 </body></html> |
