|
|
There are two classes that specifies the protocol between application (job) and kioslave. SlaveInterface is the class to use on the application end, SlaveBase is the one to use on the slave end.
Slave implementations should simply inherit SlaveBase
A call to foo() results in a call to slotFoo() on the other end.
|
~ |
[virtual]
void |
void |
Connection * |
[const]
void |
Call to send data in the slave (i.e. in get).
Parameters:
void |
Call to ask for data (in put)
void |
Call to signal an error. This also finishes the job, no need to call finished.
void |
Call in openConnection, if you reimplement it, when you're done. Currently unused.
void |
Call to signal successful completion of any command (besides openConnection and closeConnection)
void |
Call to signal that data from the sub-URL is needed
void |
Used to report the status of the slave.
Parameters:
void |
Call this once in stat()
void |
Call this in listDir, each time you have a bunch of entries to report.
bool |
Call this at the beginning of put(), to give the size of the existing
partial file, if there is one. The offset
argument notifies the
other job (the one that gets the data) about the offset to use.
In this case, the boolean returns whether we can indeed resume or not
(we can't if the protocol doing the get() doesn't support setting an offset)
void |
void |
Call this in get and copy, to give the total size of the file Call in listDir too, when you know the total number of items.
void |
Call this during get and copy, once in a while, to give some info about the current state. Don't emit it in listDir, listEntries speaks for itself.
void |
Call this in get and copy, to give the current transfer speed. Usually worked out as processed_size / ( t - t_start )
void |
Call this to signal a redirection The job will take care of going to that url.
void |
Tell that we will only get an error page here. This means: the data you'll get isn't the data you requested, but an error page (usually HTML) that describes an error.
void |
Call this in mimetype, when you know the mimetype. See mimetype about other ways to implement it.
void |
void |
Call to signal a warning, to be displayed in a dialog box.
void |
Call to signal a message, to be displayed if the application wants to, for instance in a status bar. Usual examples are "connecting to host xyz", etc.
enum |
int |
Call this to show a message box from the slave (it will in fact be handled by kio_uiserver, so that the progress info dialog for the slave is hidden while this message box is shown)
Parameters:
Returns: a button code, as defined in KMessageBox, or 0 on communication error.
void |
Sets meta-data to be send to the application before the first data() or finished() signal.
QString |
Queries for meta-data send by the application to the slave.
void |
[virtual]
Set the host
This method is called whenever a change in host, port or user occurs.
Parameters:
void |
[virtual]
Prepare slave for streaming operation
void |
[virtual]
Opens the connection (forced) Currently unused.
void |
[virtual]
Closes the connection (forced) Currently unused.
void |
[virtual]
get, aka read.
Parameters:
void |
[virtual]
put, aka write.
Parameters:
void |
[virtual]
Finds all details for one file or directory. The information returned is the same as what listDir returns, but only for one file or directory.
void |
[virtual]
Finds mimetype for one file or directory.
This method should either emit 'mimeType' or it should send a block of data big enough to be able to determine the mimetype.
If the slave doesn't reimplement it, a get will be issued, i.e. the whole file will be downloaded before determining the mimetype on it - this is obviously not a good thing in most cases.
void |
[virtual]
Lists the contents of path.
The slave should emit ERR_CANNOT_ENTER_DIRECTORY if it doesn't exist,
if we don't have enough permissions, or if it is a file
It should also emit totalFiles as soon as it knows how many
files it will list.
void |
[virtual]
Create a directory
Parameters:
void |
[virtual]
Rename oldname
into newname.
If the slave returns an error ERR_UNSUPPORTED_ACTION, the job will
ask for copy + del instead.
Parameters:
void |
[virtual]
Creates a symbolic link named dest,
pointing to target,
which
may be a relative or an absolute path.
Parameters:
void |
[virtual]
Change permissions on path
The slave emits ERR_DOES_NOT_EXIST or ERR_CANNOT_CHMOD
void |
[virtual]
Copy src
into dest.
If the slave returns an error ERR_UNSUPPORTED_ACTION, the job will
ask for get + put instead.
Parameters:
void |
[virtual]
Delete a file or directory.
Parameters:
void |
[virtual]
Used for any command that is specific to this slave (protocol) Examples are : HTTP POST, mount and unmount (kio_file)
Parameters:
void |
[virtual]
Called to get the status of the slave. Slave should respond by calling slaveStatus(...)
void |
[virtual]
Called by the scheduler to tell the slave that the configuration changed (i.e. proxy settings) .
void |
[static]
void |
[static]
bool |
[virtual]
void |
[virtual]
int |
Read data send by the job, after a dataReq
Parameters:
Returns: 0 on end of data, > 0 bytes read < 0 error
void |
[protected]
internal function to be called by the slave. It collects entries and emits them via listEntries when enough of them are there or a certain time frame exceeded (to make sure the app gets some items in time but not too many items one by one as this will cause a drastic performance penalty)
Parameters:
void |
[protected]
internal function to connect a slave to/ disconnect from either the slave pool or the application
void |
[protected]
bool |
[protected const]
Checks whether the password daemon kdesud is up and running or can be started if it is not.
Returns: true if password daemon is/can be started successfully.
bool |
[protected]
Prompts the user for Authentication info (login & password).
This function attempts to prompt the user for a password and returns true if the user complies (clicks OK) or false otherwise (clicks Cancel).
Exception: A call to this function can also fail, result
in false,
if the UIServer could not be started for some
reason.
Parameters:
Returns: true
on if successful, false
otherwise
bool |
[protected]
Checks for any cached Authentication.
Parameters:
Returns: true
if a cached Authentication is found
bool |
[protected]
Same as above except in the number of arguments it takes.
This is a convenience method for protocols that have simple Authentication and do not require complex caching schemes such as ftp
Parameters:
Returns: true
if cached Authentication if found
bool |
[protected]
Caches Authentication information in kdesu daemon.
Authentication caching is based on the following criteria:
i.) The protocol as part of the key generation. This will reduce the chances of inadvertantly sending password to the incorrect server. Thus, http://www.foobar.org and ftp://www.foobar.org are treated as different request sites even if the same Authentication is assigned to the user for accessing both locations.
ii.) Cache different servers on the the same host but with different port numbers. For example, one might have multiple web-based admin tools, such as Webmin and SWAT, on the same server with different port numbers.
iii.) Use reference counting to keep track of all applications that are requesting password caching for the same location instead of storing duplicate enteries. The cached password can then be deleted when the last application referencing it is destroyed.
iv.) Allow redundant password caching for the same host based on heirarchy such that protocols, such as HTTP, can store Authentication info for multiple password protected content within the same site. For example, http://foo.org/foo/foo.html and http://foo.org/foo/bar/bar.html would fall under the same protection space while http://foo.org/foobar/foo.html would not and hence gets a different entry. Refer to RFC 2617 for further details.
Parameters:
Returns: true
if Authentication was sucessfully cached
QString |
[protected]
Creates a basic key to be used to cache the password.
Parameters:
Returns: NULL if url
is malformed, otherwise the generated key.
void |
[protected]
Deletes any cached keys for the given group.
Parameters:
bool |
[protected]
Used by the slave to check if it can connect to a given host. This should be called where the slave is ready to do a ::connect() on a socket. For each call to requestNetwork must exist a matching call to dropNetwork, or the system will stay online until KNetMgr gets closed (or the SlaveBase gets destructed)!
If KNetMgr is not running, then this is a no-op and returns true
Parameters:
Returns: true in theorie, the host is reachable false the system is offline and the host is in a remote network.
void |
[protected]
Used by the slave to withdraw a connection requested by requestNetwork. This function cancels the last call to requestNetwork. If a client uses more than one internet connection, it must use dropNetwork(host) to stop each request.
If KNetMgr is not running, then this is a no-op.
A slave should call this function every time it disconnect from a host.
Parameters:
int |
[protected]
Wait for an answer to our request, until we get expected1
or expected2
Returns: the result from readData, as well as the cmd in *pCmd if set, and the data in data
QCString |
[protected]
Name of the protocol supported by this slave
Connection * |
[protected]
void |
[protected]
Internal function to transmit meta data to the application.
Generated by: baudens@ke.mandrakesoft.com on Thu Oct 26 17:36:34 2000, using kdoc 2.0a40. |