<?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.common.planet.ManagerComponentState</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.common-module.html">Package common</a> ::
<a href="flumotion.common.planet-module.html">Module planet</a> ::
Class ManagerComponentState
</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 ManagerComponentState</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.common.planet-pysrc.html#ManagerComponentState">source code</a></span></p>
<pre class="base-tree">
twisted.spread.jelly.Jellyable --+
|
twisted.spread.flavors.Serializable --+
|
twisted.spread.flavors.Copyable --+
|
twisted.spread.flavors.Cacheable --+
|
<a href="flumotion.twisted.flavors.StateCacheable-class.html">twisted.flavors.StateCacheable</a> --+
|
<strong class="uidshort">ManagerComponentState</strong>
</pre>
<hr />
<p>I represent the state of a component in the manager. I have my own
state, and also proxy state from the <a
href="flumotion.common.planet.ManagerJobState-class.html"
class="link">ManagerJobState</a> when the component is actually created
in a worker.</p>
<p>I have the following keys of my own:</p>
<ul>
<li>
name: str, name of the component, unique in the parent
</li>
<li>
parent: <a
href="flumotion.common.planet.ManagerFlowState-class.html"
class="link">ManagerFlowState</a> or <a
href="flumotion.common.planet.ManagerAtmosphereState-class.html"
class="link">ManagerAtmosphereState</a>
</li>
<li>
type: str, type of the component
</li>
<li>
moodPending: int, the mood value the component is being set to
</li>
<li>
workerRequested: str, name of the worker this component is
requested to be started on.
</li>
<li>
config: dict, the configuration dict for this component
</li>
</ul>
<p>It also has a special key, 'mood'. This acts as a proxy for the mood
in the <a href="flumotion.common.planet.WorkerJobState-class.html"
class="link">WorkerJobState</a>, when there is a job attached (the job's
copy is authoritative when it connects), and is controlled independently
at other times.</p>
<p>I proxy the following keys from the serialized <a
href="flumotion.common.planet.WorkerJobState-class.html"
class="link">WorkerJobState</a>:</p>
<ul>
<li>
mood, manager-ip, pid, workerName
</li>
<li>
messages (list)
</li>
</ul>
<!-- ==================== 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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.common.planet.ManagerComponentState-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.planet-pysrc.html#ManagerComponentState.__init__">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 name="__repr__"></a><span class="summary-sig-name">__repr__</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.planet-pysrc.html#ManagerComponentState.__repr__">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.common.planet.ManagerComponentState-class.html#setJobState" class="summary-sig-name">setJobState</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">jobState</span>)</span><br />
Set the job state I proxy from.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.planet-pysrc.html#ManagerComponentState.setJobState">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.common.planet.ManagerComponentState-class.html#set" class="summary-sig-name">set</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">key</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Set a given state key to the given value.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.planet-pysrc.html#ManagerComponentState.set">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 name="setMood"></a><span class="summary-sig-name">setMood</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">moodValue</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.planet-pysrc.html#ManagerComponentState.setMood">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 name="clearJobState"></a><span class="summary-sig-name">clearJobState</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">shutdownRequested</span>)</span><br />
Remove the job state.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.planet-pysrc.html#ManagerComponentState.clearJobState">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.twisted.flavors.StateCacheable-class.html">twisted.flavors.StateCacheable</a></code></b>:
<code><a href="flumotion.twisted.flavors.StateCacheable-class.html#addDictKey">addDictKey</a></code>,
<code><a href="flumotion.twisted.flavors.StateCacheable-class.html#addKey">addKey</a></code>,
<code><a href="flumotion.twisted.flavors.StateCacheable-class.html#addListKey">addListKey</a></code>,
<code><a href="flumotion.twisted.flavors.StateCacheable-class.html#append">append</a></code>,
<code><a href="flumotion.twisted.flavors.StateCacheable-class.html#delitem">delitem</a></code>,
<code><a href="flumotion.twisted.flavors.StateCacheable-class.html#get">get</a></code>,
<code><a href="flumotion.twisted.flavors.StateCacheable-class.html#getStateToCacheAndObserveFor">getStateToCacheAndObserveFor</a></code>,
<code><a href="flumotion.twisted.flavors.StateCacheable-class.html#hasKey">hasKey</a></code>,
<code><a href="flumotion.twisted.flavors.StateCacheable-class.html#keys">keys</a></code>,
<code><a href="flumotion.twisted.flavors.StateCacheable-class.html#remove">remove</a></code>,
<code><a href="flumotion.twisted.flavors.StateCacheable-class.html#setitem">setitem</a></code>,
<code><a href="flumotion.twisted.flavors.StateCacheable-class.html#stoppedObserving">stoppedObserving</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.spread.flavors.Cacheable</code></b>:
<code>jellyFor</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.spread.flavors.Copyable</code></b>:
<code>getStateToCopy</code>,
<code>getStateToCopyFor</code>,
<code>getTypeToCopy</code>,
<code>getTypeToCopyFor</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>
</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>twisted.spread.flavors.Copyable</code></b>:
<code>__implemented__</code>,
<code>__provides__</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="__init__"></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">__init__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.planet-pysrc.html#ManagerComponentState.__init__">source code</a></span>
</td>
</tr></table>
<dl class="fields">
<dt>Overrides:
<a href="flumotion.twisted.flavors.StateCacheable-class.html#__init__">twisted.flavors.StateCacheable.__init__</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="setJobState"></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">setJobState</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">jobState</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.planet-pysrc.html#ManagerComponentState.setJobState">source code</a></span>
</td>
</tr></table>
<p>Set the job state I proxy from.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>jobState</code></strong> (<a href="flumotion.common.planet.ManagerJobState-class.html"
class="link">ManagerJobState</a>)</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="set"></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">set</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">key</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.planet-pysrc.html#ManagerComponentState.set">source code</a></span>
</td>
</tr></table>
<p>Set a given state key to the given value. Notifies observers of this
Cacheable through observe_set.</p>
<dl class="fields">
<dt>Overrides:
<a href="flumotion.twisted.flavors.StateCacheable-class.html#set">twisted.flavors.StateCacheable.set</a>
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</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 Sun Sep 13 13:14:04 2009
</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>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
contrib-release
>
by-pkgid
>
2eca861f24be6048290ed27335ec22aa
>
files
>
399
