From e19722342046756a90d65060c756198e31ff4457 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sl=C3=A1vek=20Banko?= Date: Tue, 3 Sep 2013 20:03:11 +0200 Subject: Additional k => tde renaming and fixes --- doc/kdearch/index.docbook | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) (limited to 'doc/kdearch') diff --git a/doc/kdearch/index.docbook b/doc/kdearch/index.docbook index eb7ca4e9..97dee33d 100644 --- a/doc/kdearch/index.docbook +++ b/doc/kdearch/index.docbook @@ -16,7 +16,7 @@ Bernd Gehrmann -
bernd@tdevelop.org
 +
bernd@kdevelop.org
 @@ -71,9 +71,9 @@ respecting user preferences. -kio +tdeio -The kio library contains facilities for asynchronous, +The tdeio library contains facilities for asynchronous, network transparent I/O and access to mimetype handling. It also provides the KDE file dialog and its helper classes. @@ -2074,7 +2074,7 @@ needed. It then goes into a loop and listens for DCOP connections. The program may be an interactive one, but it may also run completely or for a part of its lifetime as a daemon in the background without the user noticing it. An example for such a daemon is tdeio_uiserver, which implements user interaction -such as progress dialog for the KIO library. The advantage of such a centralized +such as progress dialog for the TDEIO library. The advantage of such a centralized daemon in this context is that e.g. the download progress for several different files can be shown in one window, even if those downloads were initiated from different applications. @@ -2393,7 +2393,7 @@ else -This starts a KIO job to download a part of the file and check this. +This starts a TDEIO job to download a part of the file and check this. Note that this function is perhaps quite slow and blocks the program. Normally you will only want to use this if KMimeType::findByURL() has returned "application/octet-stream". @@ -2401,7 +2401,7 @@ has returned "application/octet-stream". On the other hand, if you do not want to block your application, you can also -explicitly start the KIO job and connect to some of its signals: +explicitly start the TDEIO job and connect to some of its signals: @@ -2558,7 +2558,7 @@ completely available, but should updated regularly as data comes in. -In the KDE libraries, network transparency is implemented in the KIO API. The +In the KDE libraries, network transparency is implemented in the TDEIO API. The central concept of this architecture is an IO job. A job may copy, or delete files or similar things. Once a job is started, it works in the background and does not block the application. Any communication from @@ -2589,10 +2589,10 @@ http://www-com.physik.hu-berlin.de/~bernd/article.tgz#tar:/paper.tex -Using KIO +Using TDEIO -In most cases, jobs are created by calling functions in the KIO namespace. +In most cases, jobs are created by calling functions in the TDEIO namespace. These functions take one or two URLs as arguments, and possible other necessary parameters. When the job is finished, it emits the signal result(TDEIO::Job*). After this signal has been emitted, the job @@ -2855,7 +2855,7 @@ easier to use: the class KFileItem. Synchronous usage -Often, the asynchronous API of KIO is too complex to use and therefore +Often, the asynchronous API of TDEIO is too complex to use and therefore implementing full asynchronicity is not a priority. For example, in a program that can only handle one document file at a time, there is little that can be done while the program is downloading a file anyway. For these simple cases, @@ -2965,7 +2965,7 @@ void FooClass::transferResult(TDEIO::Job *job) Scheduling -When using the KIO API, you usually do not have to cope with the details of +When using the TDEIO API, you usually do not have to cope with the details of starting IO slaves and communicating with them. The normal use case is to start a job and with some parameters and handle the signals the jobs emits. @@ -2973,7 +2973,7 @@ start a job and with some parameters and handle the signals the jobs emits. Behind the curtains, the scenario is a lot more complicated. When you create a job, it is put in a queue. When the application goes back to the event loop, -KIO allocates slave processes for the jobs in the queue. For the first jobs +TDEIO allocates slave processes for the jobs in the queue. For the first jobs started, this is trivial: an IO slave for the appropriate protocol is started. However, after the job (like a download from an http server) has finished, it is not immediately killed. Instead, it is put in a pool of idle slaves and @@ -2988,7 +2988,7 @@ Of course, reusing is only possible when the existing slave has already finished its previous job. when a new request arrives while an existing slave process is still running, a new process must be started and used. In the API usage in the examples above, there are no limitation for creating new slave processes: if you -start a consecutive series of downloads for 20 different files, then KIO will +start a consecutive series of downloads for 20 different files, then TDEIO will start 20 slave processes. This scheme of assigning slaves to jobs is called direct. It not always the most appropriate scheme, as it may need much memory and put a high load on both the client and server machines. @@ -3093,14 +3093,14 @@ The "input" and "output" lines are not used currently. The remaining lines in the .protocol file define which abilities the slave has. In general, the features a slave must implement are -much simpler than the features the KIO API provides for the application. The +much simpler than the features the TDEIO API provides for the application. The reason for this is that complex jobs are scheduled to a couple of subjobs. For example, in order to list a directory recursively, one job will be started for the toplevel directory. Then for each subdirectory reported back, new subjobs -are started. A scheduler in KIO makes sure that not too many jobs are active +are started. A scheduler in TDEIO makes sure that not too many jobs are active at the same time. Similarly, in order to copy a file within a protocol that does not support copying directly (like the ftp: protocol), -KIO can read the source file and then write the data to the destination +TDEIO can read the source file and then write the data to the destination file. For this to work, the .protocol must advertise the actions its slave supports. @@ -3174,7 +3174,7 @@ functions: Additionally, there are reimplementable functions not listed in the .protocol -file. For these operations, KIO automatically determines whether they are supported +file. For these operations, TDEIO automatically determines whether they are supported or not (i.e. the default implementation returns an error). -- cgit v1.2.1