<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>flumotion.worker.job.ComponentJobHeaven</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package flumotion ::
<a href="flumotion.worker-module.html">Package worker</a> ::
<a href="flumotion.worker.job-module.html">Module job</a> ::
Class ComponentJobHeaven
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class ComponentJobHeaven</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.worker.job-pysrc.html#ComponentJobHeaven">source code</a></span></p>
<pre class="base-tree">
twisted.spread.jelly.Jellyable --+
|
twisted.spread.flavors.Serializable --+
|
twisted.spread.flavors.Referenceable --+
|
twisted.spread.flavors.Root --+
|
<a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a> --+
|
<a href="flumotion.worker.base.BaseJobHeaven-class.html">base.BaseJobHeaven</a> --+
|
<strong class="uidshort">ComponentJobHeaven</strong>
</pre>
<hr />
<!-- ==================== NESTED CLASSES ==================== -->
<a name="section-NestedClasses"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Nested Classes</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-NestedClasses"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.worker.job.ComponentJobAvatar-class.html" class="summary-name">avatarClass</a><br />
hash(x)
</td>
</tr>
</table>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="flumotion.common.connection.PBConnectionInfo-class.html"
class="link">flumotion.common.connection.PBConnectionInfo</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="getManagerConnectionInfo"></a><span class="summary-sig-name">getManagerConnectionInfo</span>(<span class="summary-sig-arg">self</span>)</span><br />
Gets the <a
href="flumotion.common.connection.PBConnectionInfo-class.html"
class="link">flumotion.common.connection.PBConnectionInfo</a>
describing how to connect to the manager.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.worker.job-pysrc.html#ComponentJobHeaven.getManagerConnectionInfo">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.worker.job.ComponentJobHeaven-class.html#spawn" class="summary-sig-name">spawn</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">avatarId</span>,
<span class="summary-sig-arg">type</span>,
<span class="summary-sig-arg">moduleName</span>,
<span class="summary-sig-arg">methodName</span>,
<span class="summary-sig-arg">nice</span>,
<span class="summary-sig-arg">bundles</span>,
<span class="summary-sig-arg">conf</span>)</span><br />
Spawn a new job.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.worker.job-pysrc.html#ComponentJobHeaven.spawn">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.worker.base.BaseJobHeaven-class.html">base.BaseJobHeaven</a></code></b>:
<code><a href="flumotion.worker.base.BaseJobHeaven-class.html#__init__">__init__</a></code>,
<code><a href="flumotion.worker.base.BaseJobHeaven-class.html#__provides__">__provides__</a></code>,
<code><a href="flumotion.worker.base.BaseJobHeaven-class.html#addJobInfo">addJobInfo</a></code>,
<code><a href="flumotion.worker.base.BaseJobHeaven-class.html#getJobInfo">getJobInfo</a></code>,
<code><a href="flumotion.worker.base.BaseJobHeaven-class.html#getJobInfos">getJobInfos</a></code>,
<code><a href="flumotion.worker.base.BaseJobHeaven-class.html#getJobPids">getJobPids</a></code>,
<code><a href="flumotion.worker.base.BaseJobHeaven-class.html#getWorkerName">getWorkerName</a></code>,
<code><a href="flumotion.worker.base.BaseJobHeaven-class.html#jobStopped">jobStopped</a></code>,
<code><a href="flumotion.worker.base.BaseJobHeaven-class.html#kill">kill</a></code>,
<code><a href="flumotion.worker.base.BaseJobHeaven-class.html#killJob">killJob</a></code>,
<code><a href="flumotion.worker.base.BaseJobHeaven-class.html#killJobByPid">killJobByPid</a></code>,
<code><a href="flumotion.worker.base.BaseJobHeaven-class.html#listen">listen</a></code>,
<code><a href="flumotion.worker.base.BaseJobHeaven-class.html#removeAvatar">removeAvatar</a></code>,
<code><a href="flumotion.worker.base.BaseJobHeaven-class.html#requestAvatar">requestAvatar</a></code>,
<code><a href="flumotion.worker.base.BaseJobHeaven-class.html#rotateChildLogFDs">rotateChildLogFDs</a></code>,
<code><a href="flumotion.worker.base.BaseJobHeaven-class.html#shutdown">shutdown</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.spread.flavors.Root</code></b>:
<code>rootObject</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.spread.flavors.Referenceable</code></b>:
<code>jellyFor</code>,
<code>remoteMessageReceived</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.spread.flavors.Serializable</code></b>:
<code>processUniqueID</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.spread.jelly.Jellyable</code></b>:
<code>__providedBy__</code>,
<code>getStateFor</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a></code></b>:
<code><a href="flumotion.extern.log.log.Loggable-class.html#debug">debug</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#doLog">doLog</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#error">error</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#info">info</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#log">log</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#logFunction">logFunction</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#logObjectName">logObjectName</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#warning">warning</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#warningFailure">warningFailure</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#writeMarker">writeMarker</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.worker.base.BaseJobHeaven-class.html">base.BaseJobHeaven</a></code></b>:
<code><a href="flumotion.worker.base.BaseJobHeaven-class.html#__implemented__">__implemented__</a></code>,
<code><a href="flumotion.worker.base.BaseJobHeaven-class.html#logCategory">logCategory</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.spread.flavors.Referenceable</code></b>:
<code>perspective</code>
</p>
</td>
</tr>
</table>
<!-- ==================== INSTANCE VARIABLES ==================== -->
<a name="section-InstanceVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.worker.base.BaseJobHeaven-class.html">base.BaseJobHeaven</a></code></b>:
<code><a href="flumotion.worker.base.BaseJobHeaven-class.html#avatars">avatars</a></code>,
<code><a href="flumotion.worker.base.BaseJobHeaven-class.html#brain">brain</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="spawn"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">spawn</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">avatarId</span>,
<span class="sig-arg">type</span>,
<span class="sig-arg">moduleName</span>,
<span class="sig-arg">methodName</span>,
<span class="sig-arg">nice</span>,
<span class="sig-arg">bundles</span>,
<span class="sig-arg">conf</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.worker.job-pysrc.html#ComponentJobHeaven.spawn">source code</a></span>
</td>
</tr></table>
<p>Spawn a new job.</p>
<p>This will spawn a new flumotion-job process, running under the
requested nice level. When the job logs in, it will be told to load
bundles and run a function, which is expected to return a component.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>avatarId</code></strong> (str) - avatarId the component should use to log in</li>
<li><strong class="pname"><code>type</code></strong> (str) - type of component to start</li>
<li><strong class="pname"><code>moduleName</code></strong> (str) - name of the module to create the component from</li>
<li><strong class="pname"><code>methodName</code></strong> (str) - the factory method to use to create the component</li>
<li><strong class="pname"><code>nice</code></strong> (int) - nice level</li>
<li><strong class="pname"><code>bundles</code></strong> (list of (str, str)) - ordered list of (bundleName, bundlePath) for this component</li>
<li><strong class="pname"><code>conf</code></strong> (dict) - component configuration</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Wed Aug 11 21:33:18 2010
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
