<?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.medium.WorkerMedium</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.medium-module.html">Module medium</a> ::
Class WorkerMedium
</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 WorkerMedium</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium">source code</a></span></p>
<pre class="base-tree">
twisted.spread.jelly.Jellyable --+
|
twisted.spread.flavors.Serializable --+
|
twisted.spread.flavors.Referenceable --+
|
<a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a> --+
|
<a href="flumotion.twisted.pb.Referenceable-class.html">twisted.pb.Referenceable</a> --+
|
<a href="flumotion.common.medium.BaseMedium-class.html">common.medium.BaseMedium</a> --+
|
<a href="flumotion.common.medium.PingingMedium-class.html">common.medium.PingingMedium</a> --+
|
<strong class="uidshort">WorkerMedium</strong>
</pre>
<hr />
<p>I am a medium interfacing with the manager-side WorkerAvatar.</p>
<!-- ==================== 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.worker.medium.WorkerMedium-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">brain</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.__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="startConnecting"></a><span class="summary-sig-name">startConnecting</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">connectionInfo</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.startConnecting">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="stopConnecting"></a><span class="summary-sig-name">stopConnecting</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.stopConnecting">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">2-tuple: (list of int, bool)</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.worker.medium.WorkerMedium-class.html#remote_getPorts" class="summary-sig-name">remote_getPorts</a>(<span class="summary-sig-arg">self</span>)</span><br />
Gets the set of TCP ports that this worker is configured to use.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_getPorts">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">int, or NoneType</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.worker.medium.WorkerMedium-class.html#remote_getFeedServerPort" class="summary-sig-name">remote_getFeedServerPort</a>(<span class="summary-sig-arg">self</span>)</span><br />
Return the TCP port the Feed Server is listening on.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_getFeedServerPort">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.medium.WorkerMedium-class.html#remote_create" class="summary-sig-name">remote_create</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">conf</span>)</span><br />
Start a component of the given type with the given nice level.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_create">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">list of str</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.worker.medium.WorkerMedium-class.html#remote_checkElements" class="summary-sig-name">remote_checkElements</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">elementNames</span>)</span><br />
Checks if one or more GStreamer elements are present and can be
instantiated.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_checkElements">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.medium.WorkerMedium-class.html#remote_checkImport" class="summary-sig-name">remote_checkImport</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">moduleName</span>)</span><br />
Checks if the given module can be imported.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_checkImport">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.medium.WorkerMedium-class.html#remote_runCheck" class="summary-sig-name">remote_runCheck</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">module</span>,
<span class="summary-sig-arg">function</span>,
<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Runs the given function in the given module with the given arguments.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_runCheck">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.medium.WorkerMedium-class.html#remote_runFunction" class="summary-sig-name">remote_runFunction</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">module</span>,
<span class="summary-sig-arg">function</span>,
<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Runs the given function in the given module with the given arguments.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_runCheck">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.medium.WorkerMedium-class.html#remote_getComponents" class="summary-sig-name">remote_getComponents</a>(<span class="summary-sig-arg">self</span>)</span><br />
I return a list of componentAvatarIds, I have.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_getComponents">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.medium.WorkerMedium-class.html#remote_killJob" class="summary-sig-name">remote_killJob</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">avatarId</span>,
<span class="summary-sig-arg">signum</span>=<span class="summary-sig-default">9</span>)</span><br />
Kill one of the worker's jobs.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_killJob">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="remote_getVersions"></a><span class="summary-sig-name">remote_getVersions</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_getVersions">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">deferred that will fire an object implementing <a
href="flumotion.common.interfaces.IDirectory-class.html"
class="link">IDirectory</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.worker.medium.WorkerMedium-class.html#remote_listDirectory" class="summary-sig-name">remote_listDirectory</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">directoryName</span>)</span><br />
List the directory called path</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_listDirectory">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.medium.WorkerMedium-class.html#__provides__" class="summary-sig-name">__provides__</a>(<span class="summary-sig-arg">...</span>)</span><br />
Special descriptor for class __provides__</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.common.medium.PingingMedium-class.html">common.medium.PingingMedium</a></code></b>:
<code><a href="flumotion.common.medium.PingingMedium-class.html#remote_writeFluDebugMarker">remote_writeFluDebugMarker</a></code>,
<code><a href="flumotion.common.medium.PingingMedium-class.html#setRemoteReference">setRemoteReference</a></code>,
<code><a href="flumotion.common.medium.PingingMedium-class.html#startPinging">startPinging</a></code>,
<code><a href="flumotion.common.medium.PingingMedium-class.html#stopPinging">stopPinging</a></code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.common.medium.PingingMedium-class.html">common.medium.PingingMedium</a></code></b> (private):
<code><a href="flumotion.common.medium.PingingMedium-class.html#_disconnect" onclick="show_private();">_disconnect</a></code>,
<code><a href="flumotion.common.medium.PingingMedium-class.html#_ping" onclick="show_private();">_ping</a></code>,
<code><a href="flumotion.common.medium.PingingMedium-class.html#_pingCheck" onclick="show_private();">_pingCheck</a></code>
</p></div>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.common.medium.BaseMedium-class.html">common.medium.BaseMedium</a></code></b>:
<code><a href="flumotion.common.medium.BaseMedium-class.html#callRemote">callRemote</a></code>,
<code><a href="flumotion.common.medium.BaseMedium-class.html#callRemoteLogging">callRemoteLogging</a></code>,
<code><a href="flumotion.common.medium.BaseMedium-class.html#getBundledFunction">getBundledFunction</a></code>,
<code><a href="flumotion.common.medium.BaseMedium-class.html#hasRemoteReference">hasRemoteReference</a></code>,
<code><a href="flumotion.common.medium.BaseMedium-class.html#runBundledFunction">runBundledFunction</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.twisted.pb.Referenceable-class.html">twisted.pb.Referenceable</a></code></b>:
<code><a href="flumotion.twisted.pb.Referenceable-class.html#remoteMessageReceived">remoteMessageReceived</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.spread.flavors.Referenceable</code></b>:
<code>jellyFor</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 width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="logCategory"></a><span class="summary-name">logCategory</span> = <code title="'workermedium'"><code class="variable-quote">'</code><code class="variable-string">workermedium</code><code class="variable-quote">'</code></code><br />
Implementors can provide a category to log their messages under.
</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.medium.WorkerMedium-class.html#__implemented__" class="summary-name">__implemented__</a> = <code title="<implementedBy flumotion.worker.medium.WorkerMedium>"><implementedBy flumotion.worker.medium.Worke<code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.common.medium.PingingMedium-class.html">common.medium.PingingMedium</a></code></b> (private):
<code><a href="flumotion.common.medium.PingingMedium-class.html#_pingCheckInterval" onclick="show_private();">_pingCheckInterval</a></code>,
<code><a href="flumotion.common.medium.PingingMedium-class.html#_pingDC" onclick="show_private();">_pingDC</a></code>,
<code><a href="flumotion.common.medium.PingingMedium-class.html#_pingInterval" onclick="show_private();">_pingInterval</a></code>
</p></div>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.common.medium.BaseMedium-class.html">common.medium.BaseMedium</a></code></b>:
<code><a href="flumotion.common.medium.BaseMedium-class.html#bundleLoader">bundleLoader</a></code>,
<code><a href="flumotion.common.medium.BaseMedium-class.html#remoteLogName">remoteLogName</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 width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="flumotion.worker.worker.WorkerBrain-class.html"
class="link">worker.WorkerBrain</a></span>
</td><td class="summary">
<a name="brain"></a><span class="summary-name">brain</span><br />
the worker brain
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="flumotion.worker.medium.WorkerClientFactory-class.html"
class="link">WorkerClientFactory</a></span>
</td><td class="summary">
<a name="factory"></a><span class="summary-name">factory</span><br />
the worker client factory
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.common.medium.BaseMedium-class.html">common.medium.BaseMedium</a></code></b>:
<code><a href="flumotion.common.medium.BaseMedium-class.html#remote">remote</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="__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 class="sig-arg">brain</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.__init__">source code</a></span>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>brain</code></strong> (<a href="flumotion.worker.worker.WorkerBrain-class.html"
class="link">worker.WorkerBrain</a>)</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="remote_getPorts"></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">remote_getPorts</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_getPorts">source code</a></span>
</td>
</tr></table>
<p>Gets the set of TCP ports that this worker is configured to use.</p>
<dl class="fields">
<dt>Returns: 2-tuple: (list of int, bool)</dt>
<dd>list of ports, and a boolean if we allocate ports randomly</dd>
</dl>
</td></tr></table>
</div>
<a name="remote_getFeedServerPort"></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">remote_getFeedServerPort</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_getFeedServerPort">source code</a></span>
</td>
</tr></table>
<p>Return the TCP port the Feed Server is listening on.</p>
<dl class="fields">
<dt>Returns: int, or NoneType</dt>
<dd>TCP port number, or None if there is no feed server</dd>
</dl>
</td></tr></table>
</div>
<a name="remote_create"></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">remote_create</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">conf</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_create">source code</a></span>
</td>
</tr></table>
<p>Start a component of the given type with the given nice level. Will
spawn a new job process to run the component in.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>avatarId</code></strong> (str) - avatar identification string</li>
<li><strong class="pname"><code>type</code></strong> (str) - type of the component to create</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>conf</code></strong> (dict) - component config</li>
</ul></dd>
<dt>Returns:</dt>
<dd>a deferred fired when the process has started and created the
component</dd>
</dl>
</td></tr></table>
</div>
<a name="remote_checkElements"></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">remote_checkElements</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">elementNames</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_checkElements">source code</a></span>
</td>
</tr></table>
<p>Checks if one or more GStreamer elements are present and can be
instantiated.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>elementNames</code></strong> (list of str) - names of the Gstreamer elements</li>
</ul></dd>
<dt>Returns: list of str</dt>
<dd>a list of instantiatable element names</dd>
</dl>
</td></tr></table>
</div>
<a name="remote_checkImport"></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">remote_checkImport</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">moduleName</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_checkImport">source code</a></span>
</td>
</tr></table>
<p>Checks if the given module can be imported.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>moduleName</code></strong> (str) - name of the module to check</li>
</ul></dd>
<dt>Returns:</dt>
<dd>None or Failure</dd>
</dl>
</td></tr></table>
</div>
<a name="remote_runCheck"></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">remote_runCheck</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">module</span>,
<span class="sig-arg">function</span>,
<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_runCheck">source code</a></span>
</td>
</tr></table>
<p>Runs the given function in the given module with the given
arguments.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>module</code></strong> (str) - module the function lives in</li>
<li><strong class="pname"><code>function</code></strong> (str) - function to run</li>
</ul></dd>
<dt>Returns:</dt>
<dd>the return value of the given function in the module.</dd>
</dl>
</td></tr></table>
</div>
<a name="remote_runFunction"></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">remote_runFunction</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">module</span>,
<span class="sig-arg">function</span>,
<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_runCheck">source code</a></span>
</td>
</tr></table>
<p>Runs the given function in the given module with the given
arguments.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>module</code></strong> (str) - module the function lives in</li>
<li><strong class="pname"><code>function</code></strong> (str) - function to run</li>
</ul></dd>
<dt>Returns:</dt>
<dd>the return value of the given function in the module.</dd>
</dl>
</td></tr></table>
</div>
<a name="remote_getComponents"></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">remote_getComponents</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_getComponents">source code</a></span>
</td>
</tr></table>
<p>I return a list of componentAvatarIds, I have. I am called by the
manager soon after I attach to it. This is needed on reconnects so that
the manager knows what components it needs to start on me.</p>
<dl class="fields">
<dt>Returns:</dt>
<dd>a list of componentAvatarIds</dd>
</dl>
</td></tr></table>
</div>
<a name="remote_killJob"></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">remote_killJob</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">avatarId</span>,
<span class="sig-arg">signum</span>=<span class="sig-default">9</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_killJob">source code</a></span>
</td>
</tr></table>
<p>Kill one of the worker's jobs.</p>
<p>This method is intended for exceptional purposes only; a normal
component shutdown is performed by the manager via calling remote_stop()
on the component avatar.</p>
<p>Raises <a
href="flumotion.common.errors.UnknownComponentError-class.html"
class="link">flumotion.common.errors.UnknownComponentError</a> if the job
is unknown.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>avatarId</code></strong> (string) - the avatar Id of the component, e.g. '/default/audio-encoder'</li>
<li><strong class="pname"><code>signum</code></strong> (int) - Signal to send, optional. Defaults to SIGKILL.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="remote_listDirectory"></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">remote_listDirectory</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">directoryName</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerMedium.remote_listDirectory">source code</a></span>
</td>
</tr></table>
<p>List the directory called path</p>
<dl class="fields">
<dt>Returns: deferred that will fire an object implementing <a
href="flumotion.common.interfaces.IDirectory-class.html"
class="link">IDirectory</a></dt>
<dd>the directory</dd>
</dl>
</td></tr></table>
</div>
<a name="__provides__"></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">__provides__</span>(<span class="sig-arg">...</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<pre class="literalblock">
Special descriptor for class __provides__
The descriptor caches the implementedBy info, so that
we can get declarations for objects without instance-specific
interfaces a bit quicker.
For example:
>>> from zope.interface import Interface
>>> class IFooFactory(Interface):
... pass
>>> class IFoo(Interface):
... pass
>>> class C(object):
... implements(IFoo)
... classProvides(IFooFactory)
>>> [i.getName() for i in C.__provides__]
['IFooFactory']
>>> [i.getName() for i in C().__provides__]
['IFoo']
</pre>
<dl class="fields">
<dt>Overrides:
<a href="flumotion.extern.log.log.Loggable-class.html#__provides__">extern.log.log.Loggable.__provides__</a>
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
<a name="section-ClassVariableDetails"></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">Class Variable Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariableDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__implemented__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">__implemented__</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<implementedBy flumotion.worker.medium.WorkerMedium>
</pre></td></tr></table>
</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>
