KIO::Scheduler

#include <KIO/Scheduler>

Inheritance diagram for KIO::Scheduler:

Signals

Q_SCRIPTABLE void reparseSlaveConfiguration (const QString &)
 
void slaveConnected (KIO::Slave *slave)
 
void slaveError (KIO::Slave *slave, int error, const QString &errorMsg)
 
Q_SCRIPTABLE void slaveOnHoldListChanged ()
 

Public Member Functions

bool connect (const QObject *sender, const char *signal, const char *member)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Static Public Member Functions

static bool assignJobToSlave (KIO::Slave *slave, KIO::SimpleJob *job)
 
static void cancelJob (SimpleJob *job)
 
static void checkSlaveOnHold (bool b)
 
static bool connect (const char *signal, const QObject *receiver, const char *member)
 
static bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 
static bool disconnectSlave (KIO::Slave *slave)
 
static void doJob (SimpleJob *job)
 
static void emitReparseSlaveConfiguration ()
 
static KIO::Slave * getConnectedSlave (const QUrl &url, const KIO::MetaData &config=MetaData())
 
static bool isSlaveOnHoldFor (const QUrl &url)
 
static void jobFinished (KIO::SimpleJob *job, KIO::Slave *slave)
 
static void publishSlaveOnHold ()
 
static void putSlaveOnHold (KIO::SimpleJob *job, const QUrl &url)
 
static void removeSlaveOnHold ()
 
static void scheduleJob (SimpleJob *job)
 
static void setJobPriority (SimpleJob *job, int priority)
 
static void updateInternalMetaData (SimpleJob *job)
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

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(QUrl("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:

TransferJob *job = KIO::get(QUrl("http://www.kde.org"));

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:

QUrl("pop3://bastian:[email protected]"));
TransferJob *job1 = KIO::get(
QUrl("pop3://bastian:[email protected]/msg1"));
TransferJob *job2 = KIO::get(
QUrl("pop3://bastian:[email protected]/msg2"));
TransferJob *job3 = KIO::get(
QUrl("pop3://bastian:[email protected]/msg3"));
// ... Wait for jobs to finish...

Note that you need to explicitly disconnect the slave when the connection goes down, so your error handler should contain:

if (error == KIO::ERR_CONNECTION_BROKEN)
See also
KIO::Slave
KIO::Job

Definition at line 109 of file scheduler.h.

Member Function Documentation

bool Scheduler::assignJobToSlave ( KIO::Slave *  slave,
KIO::SimpleJob job 
)
static

Uses slave to do job.

This function should be called immediately after creating a Job.

Parameters
slaveThe slave to use. The slave must have been obtained with a call to getConnectedSlave and must not be currently assigned to any other job.
jobThe job to do.
Returns
true is successful, false otherwise.
See also
getConnectedSlave()
disconnectSlave()
slaveConnected()
slaveError()

Definition at line 868 of file scheduler.cpp.

void Scheduler::cancelJob ( SimpleJob job)
static

Stop the execution of a job.

Parameters
jobthe job to cancel

Definition at line 827 of file scheduler.cpp.

void Scheduler::checkSlaveOnHold ( bool  b)
static

When true, the next job will check whether KLauncher has a slave on hold that is suitable for the job.

Parameters
btrue when KLauncher has a job on hold

Definition at line 902 of file scheduler.cpp.

bool Scheduler::connect ( const char *  signal,
const QObject receiver,
const char *  member 
)
static

Function to connect signals emitted by the scheduler.

See also
slaveConnected()
slaveError()

Definition at line 878 of file scheduler.cpp.

bool Scheduler::disconnectSlave ( KIO::Slave *  slave)
static

Disconnects slave.

Parameters
slaveThe slave to disconnect. The slave must have been obtained with a call to getConnectedSlave and must not be assigned to any job.
Returns
true is successful, false otherwise.
See also
getConnectedSlave
assignJobToSlave

Definition at line 873 of file scheduler.cpp.

void Scheduler::doJob ( SimpleJob job)
static

Register job with the scheduler.

The default is to create a new slave for the job if no slave is available. This can be changed by calling setJobPriority.

Parameters
jobthe job to register

Definition at line 810 of file scheduler.cpp.

KIO::Slave * Scheduler::getConnectedSlave ( const QUrl url,
const KIO::MetaData config = MetaData() 
)
static

Requests a slave for use in connection-oriented mode.

Parameters
urlThis defines the username,password,host & port to connect with.
configConfiguration data for the slave.
Returns
A pointer to a connected slave or nullptr if an error occurred.
See also
assignJobToSlave()
disconnectSlave()

Definition at line 862 of file scheduler.cpp.

bool Scheduler::isSlaveOnHoldFor ( const QUrl url)
static

Returns true if there is a slave on hold for url.

Since
4.7

Definition at line 852 of file scheduler.cpp.

void Scheduler::jobFinished ( KIO::SimpleJob job,
KIO::Slave *  slave 
)
static

Called when a job is done.

Parameters
jobthe finished job
slavethe slave that executed the job

Definition at line 832 of file scheduler.cpp.

void Scheduler::publishSlaveOnHold ( )
static

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 847 of file scheduler.cpp.

void Scheduler::putSlaveOnHold ( KIO::SimpleJob job,
const QUrl url 
)
static

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.

Parameters
jobthe job that should be stopped
urlthe URL that is handled by the url

Definition at line 837 of file scheduler.cpp.

void Scheduler::removeSlaveOnHold ( )
static

Removes any slave that might have been put on hold.

If a slave was put on hold it will be killed.

Definition at line 842 of file scheduler.cpp.

void Scheduler::scheduleJob ( SimpleJob job)
static

Schedules job scheduled for later execution.

This method is deprecated and just sets the job's priority to 1. It is recommended to replace calls to scheduleJob(job) with setJobPriority(job, 1).

Parameters
jobthe job to schedule
Deprecated:
Since 4.5, use setJobPriority(SimpleJob *job, int priority)

Definition at line 816 of file scheduler.cpp.

void Scheduler::setJobPriority ( SimpleJob job,
int  priority 
)
static

Changes the priority of job; jobs of the same priority run in the order in which they were created.

Jobs of lower numeric priority always run before any waiting jobs of higher numeric priority. The range of priority is -10 to 10, the default priority of jobs is 0.

Parameters
jobthe job to change
prioritynew priority of job, lower runs earlier

Definition at line 822 of file scheduler.cpp.

void Scheduler::updateInternalMetaData ( SimpleJob job)
static

Updates the internal metadata from job.

Since
4.6.5

Definition at line 857 of file scheduler.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Fri Jul 10 2020 22:59:08 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.