<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>KIO.Scheduler</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.4 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>Scheduler Class Reference</h1>
<code>from PyKDE4.kio import *</code>
<p>
Inherits: <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a><br />
Namespace: KIO.Scheduler<br />
<h2>Detailed Description</h2>
<p>The KIO.Scheduler manages io-slaves for the application.
It also queues jobs and assigns the job to a slave when one
becomes available.
</p>
<p>
There are 3 possible ways for a job to get a slave:
</p>
<p>
<h3>1. Direct</h3>
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.
</p>
<p>
Example:
<pre class="fragment">
TransferJob *job = KIO.get(KUrl("http://www.kde.org"));
</pre>
</p>
<p>
<h3>2. Scheduled</h3>
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.
</p>
<p>
Example:
<pre class="fragment">
TransferJob *job = KIO.get(KUrl("http://www.kde.org"));
KIO.Scheduler.scheduleJob(job);
</pre>
</p>
<p>
<h3>3. Connection Oriented</h3>
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.
</p>
<p>
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.
</p>
<p>
Example:
<pre class="fragment">
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);
</pre>
</p>
<p>
Note that you need to explicitly disconnect the slave when the
connection goes down, so your error handler should contain:
<pre class="fragment">
if (error == KIO.ERR_CONNECTION_BROKEN)
KIO.Scheduler.disconnectSlave(slave);
</pre>
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KIO.Slave
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> KIO.Job
</dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#reparseSlaveConfiguration">reparseSlaveConfiguration</a> (, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> a0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#slaveConnected">slaveConnected</a> (, <a href="../kio/KIO.Slave.html">KIO.Slave</a> slave)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#slaveError">slaveError</a> (, <a href="../kio/KIO.Slave.html">KIO.Slave</a> slave, int error, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> errorMsg)</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#Scheduler">__init__</a> (self, <a href="../kio/KIO.Scheduler.html">KIO.Scheduler</a> a0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#Scheduler">__init__</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#assignJobToSlave">assignJobToSlave</a> (self, <a href="../kio/KIO.Slave.html">KIO.Slave</a> slave, <a href="../kio/KIO.SimpleJob.html">KIO.SimpleJob</a> job)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#cancelJob">cancelJob</a> (self, <a href="../kio/KIO.SimpleJob.html">KIO.SimpleJob</a> job)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#checkSlaveOnHold">checkSlaveOnHold</a> (self, bool b)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#connect">connect</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> signal, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> receiver, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> member)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#connect">connect</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> sender, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> signal, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> receiver, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> member)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#connect">connect</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> sender, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> signal, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> member)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#disconnect">disconnect</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> sender, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> signal, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> receiver, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> member)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#disconnectSlave">disconnectSlave</a> (self, <a href="../kio/KIO.Slave.html">KIO.Slave</a> slave)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#doJob">doJob</a> (self, <a href="../kio/KIO.SimpleJob.html">KIO.SimpleJob</a> job)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#emitReparseSlaveConfiguration">emitReparseSlaveConfiguration</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KIO.Slave.html">KIO.Slave</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#getConnectedSlave">getConnectedSlave</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> url, <a href="../kio/KIO.MetaData.html">KIO.MetaData</a> config=KIO.MetaData())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#jobFinished">jobFinished</a> (self, <a href="../kio/KIO.SimpleJob.html">KIO.SimpleJob</a> job, <a href="../kio/KIO.Slave.html">KIO.Slave</a> slave)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#publishSlaveOnHold">publishSlaveOnHold</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#putSlaveOnHold">putSlaveOnHold</a> (self, <a href="../kio/KIO.SimpleJob.html">KIO.SimpleJob</a> job, <a href="../kdecore/KUrl.html">KUrl</a> url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#registerWindow">registerWindow</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> wid)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#removeSlaveOnHold">removeSlaveOnHold</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#reparseSlaveConfiguration">reparseSlaveConfiguration</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> a0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#scheduleJob">scheduleJob</a> (self, <a href="../kio/KIO.SimpleJob.html">KIO.SimpleJob</a> job)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#slaveConnected">slaveConnected</a> (self, <a href="../kio/KIO.Slave.html">KIO.Slave</a> slave)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#slaveError">slaveError</a> (self, <a href="../kio/KIO.Slave.html">KIO.Slave</a> slave, int error, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> errorMsg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#unregisterWindow">unregisterWindow</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> wid)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="Scheduler"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KIO.Scheduler.html">KIO.Scheduler</a> </td>
<td class="paramname"><em>a0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="Scheduler"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="assignJobToSlave"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool assignJobToSlave</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KIO.Slave.html">KIO.Slave</a> </td>
<td class="paramname"><em>slave</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KIO.SimpleJob.html">KIO.SimpleJob</a> </td>
<td class="paramname"><em>job</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Uses <b>slave</b> to do <b>job.</b>
This function should be called immediately after creating a Job.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>slave</em> </td><td> The slave to use. The slave must have been obtained
with a call to getConnectedSlave and must not
be currently assigned to any other job.
<tr><td></td><td valign="top"><em>job</em> </td><td> The job to do.
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true is successful, false otherwise.
</dd></dl> </p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> getConnectedSlave()
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> disconnectSlave()
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> slaveConnected()
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> slaveError()
</dd></dl>
</p></div></div><a class="anchor" name="cancelJob"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> cancelJob</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KIO.SimpleJob.html">KIO.SimpleJob</a> </td>
<td class="paramname"><em>job</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Stop the execution of a job.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>job</em> </td><td> the job to cancel
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="checkSlaveOnHold"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> checkSlaveOnHold</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>b</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>When true, the next job will check whether KLauncher has a slave
on hold that is suitable for the job.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>b</em> </td><td> true when KLauncher has a job on hold
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="connect"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool connect</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>signal</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> </td>
<td class="paramname"><em>receiver</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>member</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Function to connect signals emitted by the scheduler.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> slaveConnected()
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> slaveError()
</dd></dl>
</p></div></div><a class="anchor" name="connect"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool connect</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> </td>
<td class="paramname"><em>sender</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>signal</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> </td>
<td class="paramname"><em>receiver</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>member</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Function to connect signals emitted by the scheduler.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> slaveConnected()
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> slaveError()
</dd></dl>
</p></div></div><a class="anchor" name="connect"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool connect</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> </td>
<td class="paramname"><em>sender</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>signal</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>member</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Function to connect signals emitted by the scheduler.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> slaveConnected()
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> slaveError()
</dd></dl>
</p></div></div><a class="anchor" name="disconnect"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool disconnect</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> </td>
<td class="paramname"><em>sender</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>signal</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> </td>
<td class="paramname"><em>receiver</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>member</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="disconnectSlave"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool disconnectSlave</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KIO.Slave.html">KIO.Slave</a> </td>
<td class="paramname"><em>slave</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Disconnects <b>slave.</b>
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>slave</em> </td><td> The slave to disconnect. The slave must have been
obtained with a call to getConnectedSlave
and must not be assigned to any job.
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true is successful, false otherwise.
</dd></dl> </p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> getConnectedSlave
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> assignJobToSlave
</dd></dl>
</p></div></div><a class="anchor" name="doJob"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> doJob</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KIO.SimpleJob.html">KIO.SimpleJob</a> </td>
<td class="paramname"><em>job</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Register <b>job</b> 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 scheduleJob.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>job</em> </td><td> the job to register
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="emitReparseSlaveConfiguration"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> emitReparseSlaveConfiguration</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="getConnectedSlave"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kio/KIO.Slave.html">KIO.Slave</a> getConnectedSlave</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KIO.MetaData.html">KIO.MetaData</a> </td>
<td class="paramname"><em>config=KIO.MetaData()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Requests a slave for use in connection-oriented mode.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>url</em> </td><td> This defines the username,password,host & port to
connect with.
<tr><td></td><td valign="top"><em>config</em> </td><td> Configuration data for the slave.
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> A pointer to a connected slave or 0 if an error occurred.
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> assignJobToSlave()
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> disconnectSlave()
</dd></dl>
</p></div></div><a class="anchor" name="jobFinished"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> jobFinished</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KIO.SimpleJob.html">KIO.SimpleJob</a> </td>
<td class="paramname"><em>job</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KIO.Slave.html">KIO.Slave</a> </td>
<td class="paramname"><em>slave</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Called when a job is done.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>job</em> </td><td> the finished job
<tr><td></td><td valign="top"><em>slave</em> </td><td> the slave that executed the <b>job</b>
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="publishSlaveOnHold"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> publishSlaveOnHold</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>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.
</p></div></div><a class="anchor" name="putSlaveOnHold"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> putSlaveOnHold</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KIO.SimpleJob.html">KIO.SimpleJob</a> </td>
<td class="paramname"><em>job</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Puts a slave on notice. A next job may reuse this slave if it
requests the same URL.
</p>
<p>
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.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>job</em> </td><td> the job that should be stopped
<tr><td></td><td valign="top"><em>url</em> </td><td> the URL that is handled by the <b>url</b>
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="registerWindow"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> registerWindow</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> </td>
<td class="paramname"><em>wid</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Register the mainwindow <b>wid</b> with the KIO subsystem
Do not call this, it is called automatically from
void KIO.Job.setWindow(QWidget*).
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>wid</em> </td><td> the window to register
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="removeSlaveOnHold"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> removeSlaveOnHold</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Removes any slave that might have been put on hold. If a slave
was put on hold it will be killed.
</p></div></div><a class="anchor" name="reparseSlaveConfiguration"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> reparseSlaveConfiguration</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>a0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("reparseSlaveConfiguration(const QString&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="scheduleJob"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> scheduleJob</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KIO.SimpleJob.html">KIO.SimpleJob</a> </td>
<td class="paramname"><em>job</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Calling ths function makes that <b>job</b> gets scheduled for later
execution, if multiple jobs are registered it might wait for
other jobs to finish.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>job</em> </td><td> the job to schedule
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="slaveConnected"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> slaveConnected</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KIO.Slave.html">KIO.Slave</a> </td>
<td class="paramname"><em>slave</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("slaveConnected(KIO::Slave*)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="slaveError"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> slaveError</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KIO.Slave.html">KIO.Slave</a> </td>
<td class="paramname"><em>slave</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>error</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>errorMsg</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("slaveError(KIO::Slave*, int, const QString&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="unregisterWindow"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> unregisterWindow</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> </td>
<td class="paramname"><em>wid</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd>
Unregisters the window registered by registerWindow().
</dd></dl>
</p></div></div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
b77dda48f87d4eda8cc559e40c49a652
>
files
>
817
