<?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.component.component.BaseComponentMedium</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.component-module.html">Package component</a> ::
<a href="flumotion.component.component-module.html">Module component</a> ::
Class BaseComponentMedium
</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 BaseComponentMedium</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium">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">BaseComponentMedium</strong>
</pre>
<dl><dt>Known Subclasses:</dt>
<dd>
<ul class="subclass-list">
<li><a href="flumotion.component.feedcomponent.FeedComponentMedium-class.html">feedcomponent.FeedComponentMedium</a></li><li>, <a href="flumotion.component.misc.porter.porter.PorterMedium-class.html">misc.porter.porter.PorterMedium</a></li><li>, <a href="flumotion.component.misc.httpserver.httpserver.HTTPFileMedium-class.html">misc.httpserver.httpserver.HTTPFileMedium</a></li><li class="private">, <a href="flumotion.component.bouncers.bouncer.BouncerMedium-class.html" onclick="show_private();">bouncers.bouncer.BouncerMedium</a></li><li class="private">, <a href="flumotion.component.bouncers.component.BouncerMedium-class.html" onclick="show_private();">bouncers.component.BouncerMedium</a></li> </ul>
</dd></dl>
<hr />
<p>I am a medium interfacing with a manager-side avatar. I implement a
Referenceable for the manager's avatar to call on me. I have a remote
reference to the manager's avatar to call upon. I am created by the <a
href="flumotion.component.component.ComponentClientFactory-class.html"
class="link">ComponentClientFactory</a>.</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.component.component.BaseComponentMedium-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">component</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.__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 href="flumotion.component.component.BaseComponentMedium-class.html#setRemoteReference" class="summary-sig-name">setRemoteReference</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">reference</span>)</span><br />
Set the given remoteReference as the reference to the server-side
avatar.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.setRemoteReference">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="setup"></a><span class="summary-sig-name">setup</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">config</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.setup">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="getManagerIP"></a><span class="summary-sig-name">getManagerIP</span>(<span class="summary-sig-arg">self</span>)</span><br />
Return the manager IP as seen by us.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.getManagerIP">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.component.component.BaseComponentMedium-class.html#getIP" class="summary-sig-name">getIP</a>(<span class="summary-sig-arg">self</span>)</span><br />
Return the IP of this component based on connection to the manager.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.getIP">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.component.component.BaseComponentMedium-class.html#setAuthenticator" class="summary-sig-name">setAuthenticator</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">authenticator</span>)</span><br />
Set the authenticator the client factory has used to log in to the
manager.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.setAuthenticator">source code</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.planet.WorkerJobState-class.html"
class="link">flumotion.common.planet.WorkerJobState</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.component.component.BaseComponentMedium-class.html#remote_getState" class="summary-sig-name">remote_getState</a>(<span class="summary-sig-arg">self</span>)</span><br />
Return the state of the component, which will be serialized to a <a
href="flumotion.common.planet.ManagerJobState-class.html"
class="link">flumotion.common.planet.ManagerJobState</a> object.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.remote_getState">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">dict</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.component.component.BaseComponentMedium-class.html#remote_getConfig" class="summary-sig-name">remote_getConfig</a>(<span class="summary-sig-arg">self</span>)</span><br />
Return the configuration of the component.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.remote_getConfig">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_stop"></a><span class="summary-sig-name">remote_stop</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.remote_stop">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_reloadComponent"></a><span class="summary-sig-name">remote_reloadComponent</span>(<span class="summary-sig-arg">self</span>)</span><br />
Reload modules in the component.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.remote_reloadComponent">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_getUIState"></a><span class="summary-sig-name">remote_getUIState</span>(<span class="summary-sig-arg">self</span>)</span><br />
Get a WorkerComponentUIState containing details needed to present an
admin-side UI state</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.remote_getUIState">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.component.component.BaseComponentMedium-class.html#remote_getMasterClockInfo" class="summary-sig-name">remote_getMasterClockInfo</a>(<span class="summary-sig-arg">self</span>)</span><br />
Base implementation of getMasterClockInfo, can be overridden by
subclasses.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.remote_getMasterClockInfo">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.component.component-pysrc.html#BaseComponentMedium.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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.component.component.BaseComponentMedium-class.html#remote_setFluDebug" class="summary-sig-name">remote_setFluDebug</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">debug</span>)</span><br />
Sets the Flumotion debugging levels based on the passed debug string.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.remote_setFluDebug">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.component.component.BaseComponentMedium-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#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="'basecompmed'"><code class="variable-quote">'</code><code class="variable-string">basecompmed</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.component.component.BaseComponentMedium-class.html#__implemented__" class="summary-name">__implemented__</a> = <code title="<implementedBy flumotion.component.component.BaseComponentMedium>"><implementedBy flumotion.component.component<code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="flumotion.twisted.pb.Authenticator-class.html"
class="link">flumotion.twisted.pb.Authenticator</a></span>
</td><td class="summary">
<a name="authenticator"></a><span class="summary-name">authenticator</span><br />
the authenticator used to log in to manager
</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 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">component</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.__init__">source code</a></span>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>component</code></strong> - <a href="flumotion.component.component.BaseComponent-class.html"
class="link">flumotion.component.component.BaseComponent</a></li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="setRemoteReference"></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">setRemoteReference</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">reference</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.setRemoteReference">source code</a></span>
</td>
</tr></table>
<p>Set the given remoteReference as the reference to the server-side
avatar.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>remoteReference</code></strong> - <code class="link">twisted.spread.pb.RemoteReference</code></li>
</ul></dd>
<dt>Overrides:
<a href="flumotion.common.medium.BaseMedium-class.html#setRemoteReference">common.medium.BaseMedium.setRemoteReference</a>
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="getIP"></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">getIP</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.getIP">source code</a></span>
</td>
</tr></table>
<p>Return the IP of this component based on connection to the
manager.</p>
<p>Note: this is insufficient in general, and should be replaced by
network mapping stuff later.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="setAuthenticator"></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">setAuthenticator</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">authenticator</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.setAuthenticator">source code</a></span>
</td>
</tr></table>
<p>Set the authenticator the client factory has used to log in to the
manager. Can be reused by the component's medium to make feed
connections which also get authenticated by the manager's bouncer.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>authenticator</code></strong> (<a href="flumotion.twisted.pb.Authenticator-class.html"
class="link">flumotion.twisted.pb.Authenticator</a>)</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="remote_getState"></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_getState</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.remote_getState">source code</a></span>
</td>
</tr></table>
<p>Return the state of the component, which will be serialized to a <a
href="flumotion.common.planet.ManagerJobState-class.html"
class="link">flumotion.common.planet.ManagerJobState</a> object.</p>
<dl class="fields">
<dt>Returns: <a href="flumotion.common.planet.WorkerJobState-class.html"
class="link">flumotion.common.planet.WorkerJobState</a></dt>
<dd>state of component</dd>
</dl>
</td></tr></table>
</div>
<a name="remote_getConfig"></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_getConfig</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.remote_getConfig">source code</a></span>
</td>
</tr></table>
<p>Return the configuration of the component.</p>
<dl class="fields">
<dt>Returns: dict</dt>
<dd>component's current configuration</dd>
</dl>
</td></tr></table>
</div>
<a name="remote_getMasterClockInfo"></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_getMasterClockInfo</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.remote_getMasterClockInfo">source code</a></span>
</td>
</tr></table>
<p>Base implementation of getMasterClockInfo, can be overridden by
subclasses. By default, just returns None.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="remote_setFluDebug"></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_setFluDebug</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">debug</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.component.component-pysrc.html#BaseComponentMedium.remote_setFluDebug">source code</a></span>
</td>
</tr></table>
<p>Sets the Flumotion debugging levels based on the passed debug
string.</p>
<dl class="fields">
</dl>
<div class="fields"> <p><strong>Since:</strong>
0.6.0
</p>
</div></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.component.component.BaseComponentMedium>
</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:14 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>
