KIO::Scheduler Class Reference
The KIO::Scheduler manages io-slaves for the application. More...
#include <scheduler.h>
Inheritance diagram for KIO::Scheduler:


Public Types | |
typedef QPtrList< SimpleJob > | JobList |
Public Slots | |
void | slotSlaveDied (KIO::Slave *slave) |
void | slotSlaveStatus (pid_t pid, const QCString &protocol, const QString &host, bool connected) |
Signals | |
void | slaveConnected (KIO::Slave *slave) |
void | slaveError (KIO::Slave *slave, int error, const QString &errorMsg) |
Public Member Functions | |
bool | connect (const QObject *sender, const char *signal, const char *member) |
void | debug_info () |
virtual bool | process (const QCString &fun, const QByteArray &data, QCString &replyType, QByteArray &replyData) |
virtual QCStringList | functions () |
Static Public Member Functions | |
void | doJob (SimpleJob *job) |
Register job with the scheduler. | |
void | scheduleJob (SimpleJob *job) |
Calling ths function makes that job gets scheduled for later execution, if multiple jobs are registered it might wait for other jobs to finish. | |
void | cancelJob (SimpleJob *job) |
Stop the execution of a job. | |
void | jobFinished (KIO::SimpleJob *job, KIO::Slave *slave) |
Called when a job is done. | |
void | putSlaveOnHold (KIO::SimpleJob *job, const KURL &url) |
Puts a slave on notice. | |
void | removeSlaveOnHold () |
Removes any slave that might have been put on hold. | |
void | publishSlaveOnHold () |
Send the slave that was put on hold back to KLauncher. | |
KIO::Slave * | getConnectedSlave (const KURL &url, const KIO::MetaData &config=MetaData()) |
Requests a slave for use in connection-oriented mode. | |
bool | assignJobToSlave (KIO::Slave *slave, KIO::SimpleJob *job) |
bool | disconnectSlave (KIO::Slave *slave) |
void | registerWindow (QWidget *wid) |
Register the mainwindow wid with the KIO subsystem Do not call this, it is called automatically from void KIO::Job::setWindow(QWidget *window)
| |
bool | connect (const char *signal, const QObject *receiver, const char *member) |
Function to connect signals emitted by the scheduler. | |
bool | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member) |
void | checkSlaveOnHold (bool b) |
When true, the next job will check whether KLauncher has a slave on hold that is suitable for the job. | |
Protected Slots | |
void | startStep () |
void | slotCleanIdleSlaves () |
void | slotSlaveConnected () |
void | slotSlaveError (int error, const QString &errorMsg) |
void | slotScheduleCoSlave () |
void | slotUnregisterWindow (QObject *) |
| |
Protected Member Functions | |
void | setupSlave (KIO::Slave *slave, const KURL &url, const QString &protocol, const QString &proxy, bool newSlave, const KIO::MetaData *config=0) |
bool | startJobScheduled (ProtocolInfo *protInfo) |
bool | startJobDirect () |
virtual void | virtual_hook (int id, void *data) |
Detailed Description
The KIO::Scheduler manages io-slaves for the application.It also queues jobs and assigns the job to a slave when one becomes available.
There are 3 possible ways for a job to get a slave:
1) Direct. This is the default. When you create a job the KIO::Scheduler will be notified and will find either an existing slave that is idle or it will create a new slave for the job.
Example: TransferJob *job = KIO::get(KURL("http://www.kde.org"));
2) Scheduled If you create a lot of jobs, you might want not want to have a slave for each job. If you schedule a job, a maximum number of slaves will be created. When more jobs arrive, they will be queued. When a slave is finished with a job, it will be assigned a job from the queue.
Example:
3) Connection Oriented For some operations it is important that multiple jobs use the same connection. This can only be ensured if all these jobs use the same slave.
You can ask the scheduler to open a slave for connection oriented operations. You can then use the scheduler to assign jobs to this slave. The jobs will be queued and the slave will handle these jobs one after the other.
Example:
Slave *slave = KIO::Scheduler::getConnectedSlave( KURL("pop3://bastian:password@mail.kde.org")); TransferJob *job1 = KIO::get( KURL("pop3://bastian:password@mail.kde.org/msg1")); KIO::Scheduler::assignJobToSlave(slave, job1); TransferJob *job2 = KIO::get( KURL("pop3://bastian:password@mail.kde.org/msg2")); KIO::Scheduler::assignJobToSlave(slave, job2); TransferJob *job3 = KIO::get( KURL("pop3://bastian:password@mail.kde.org/msg3")); KIO::Scheduler::assignJobToSlave(slave, job3);
// ... Wait for jobs to finish...
KIO::Scheduler::disconnectSlave(slave);
Definition at line 99 of file scheduler.h.
Member Function Documentation
|
Register The default is to create a new slave for the job if no slave is available. This can be changed by calling scheduleJob. Definition at line 116 of file scheduler.h. References _doJob(). |
|
Calling ths function makes that
Definition at line 124 of file scheduler.h. References _scheduleJob(). |
|
Stop the execution of a job.
Definition at line 130 of file scheduler.h. References _cancelJob(). |
|
Called when a job is done.
Definition at line 136 of file scheduler.h. References _jobFinished(). |
|
Puts a slave on notice. A next job may reuse this slave if it requests the same URL. A job can be put on hold after it has emit'ed its mimetype. Based on the mimetype, the program can give control to another component in the same process which can then resume the job by simply asking for the same URL again. Definition at line 148 of file scheduler.h. References _putSlaveOnHold(). |
|
Removes any slave that might have been put on hold. If a slave was put on hold it will be killed. Definition at line 155 of file scheduler.h. References _removeSlaveOnHold(). |
|
Send the slave that was put on hold back to KLauncher. This allows another process to take over the slave and resume the job that was started. Definition at line 163 of file scheduler.h. References _publishSlaveOnHold(). Referenced by KRun::foundMimeType(). |
|
Requests a slave for use in connection-oriented mode.
Definition at line 177 of file scheduler.h. References _getConnectedSlave(). |
|
Register the mainwindow
Definition at line 221 of file scheduler.h. References _registerWindow(). |
|
Function to connect signals emitted by the scheduler.
Definition at line 231 of file scheduler.h. References QObject::connect(). |
|
When true, the next job will check whether KLauncher has a slave on hold that is suitable for the job.
Definition at line 251 of file scheduler.h. References _checkSlaveOnHold(). |
|
Definition at line 878 of file scheduler.cpp. References QMap< QObject *, long >::end(), and QMap< QObject *, long >::find(). |
The documentation for this class was generated from the following files: