Sophie

Sophie

distrib > Mandriva > 2010.1 > x86_64 > media > contrib-release > by-pkgid > 2eca861f24be6048290ed27335ec22aa > files > 1360

flumotion-doc-0.6.1-1mdv2010.0.x86_64.rpm

<?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.ComponentJobAvatar</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>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;flumotion ::
        <a href="flumotion.worker-module.html">Package&nbsp;worker</a> ::
        <a href="flumotion.worker.job-module.html">Module&nbsp;job</a> ::
        Class&nbsp;ComponentJobAvatar
      </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&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class ComponentJobAvatar</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.worker.job-pysrc.html#ComponentJobAvatar">source&nbsp;code</a></span></p>
<pre class="base-tree">
twisted.spread.pb.Avatar --+        
                           |        
 <a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a> --+        
                           |        
           <a href="flumotion.twisted.pb.Avatar-class.html">twisted.pb.Avatar</a> --+    
                               |    
     <a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a> --+    
                               |    
              <a href="flumotion.worker.base.BaseJobAvatar-class.html">base.BaseJobAvatar</a> --+
                                   |
                                  <strong class="uidshort">ComponentJobAvatar</strong>
</pre>

<hr />
<p>hash(x)</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">&nbsp;</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.ComponentJobAvatar-class.html#haveMind" class="summary-sig-name">haveMind</a>(<span class="summary-sig-arg">self</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="flumotion.worker.job-pysrc.html#ComponentJobAvatar.haveMind">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</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.ComponentJobAvatar-class.html#stop" class="summary-sig-name">stop</a>(<span class="summary-sig-arg">self</span>)</span><br />
      returns: a deferred marking completed stop.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="flumotion.worker.job-pysrc.html#ComponentJobAvatar.stop">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</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.ComponentJobAvatar-class.html#sendFeed" class="summary-sig-name">sendFeed</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">feedName</span>,
        <span class="summary-sig-arg">fd</span>,
        <span class="summary-sig-arg">eaterId</span>)</span><br />
      Tell the feeder to send the given feed to the given fd.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="flumotion.worker.job-pysrc.html#ComponentJobAvatar.sendFeed">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</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.ComponentJobAvatar-class.html#receiveFeed" class="summary-sig-name">receiveFeed</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">eaterAlias</span>,
        <span class="summary-sig-arg">fd</span>,
        <span class="summary-sig-arg">feedId</span>)</span><br />
      Tell the feeder to receive the given feed from the given fd.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="flumotion.worker.job-pysrc.html#ComponentJobAvatar.receiveFeed">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="perspective_cleanShutdown"></a><span class="summary-sig-name">perspective_cleanShutdown</span>(<span class="summary-sig-arg">self</span>)</span><br />
      This notification from the job process will be fired when it is 
      shutting down, so that although the process might still be around, we
      know it's OK to accept new start requests for this avatar ID.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="flumotion.worker.job-pysrc.html#ComponentJobAvatar.perspective_cleanShutdown">source&nbsp;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.BaseJobAvatar-class.html">base.BaseJobAvatar</a></code></b>:
      <code><a href="flumotion.worker.base.BaseJobAvatar-class.html#__init__">__init__</a></code>,
      <code><a href="flumotion.worker.base.BaseJobAvatar-class.html#logTo">logTo</a></code>,
      <code><a href="flumotion.worker.base.BaseJobAvatar-class.html#logout">logout</a></code>,
      <code><a href="flumotion.worker.base.BaseJobAvatar-class.html#setMind">setMind</a></code>
      </p>
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.worker.base.BaseJobAvatar-class.html">base.BaseJobAvatar</a></code></b> (private):
      <code><a href="flumotion.worker.base.BaseJobAvatar-class.html#_sendFileDescriptor" onclick="show_private();">_sendFileDescriptor</a></code>
      </p></div>
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.twisted.pb.Avatar-class.html">twisted.pb.Avatar</a></code></b>:
      <code><a href="flumotion.twisted.pb.Avatar-class.html#disconnect">disconnect</a></code>,
      <code><a href="flumotion.twisted.pb.Avatar-class.html#mindCallRemote">mindCallRemote</a></code>,
      <code><a href="flumotion.twisted.pb.Avatar-class.html#mindCallRemoteLogging">mindCallRemoteLogging</a></code>,
      <code><a href="flumotion.twisted.pb.Avatar-class.html#perspectiveMessageReceived">perspectiveMessageReceived</a></code>,
      <code><a href="flumotion.twisted.pb.Avatar-class.html#perspectiveMessageReceivedUnserialised">perspectiveMessageReceivedUnserialised</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.spread.pb.Avatar</code></b>:
      <code>__providedBy__</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.BaseJobAvatar-class.html">base.BaseJobAvatar</a></code></b>:
      <code><a href="flumotion.worker.base.BaseJobAvatar-class.html#logCategory">logCategory</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.twisted.pb.Avatar-class.html">twisted.pb.Avatar</a></code></b>:
      <code><a href="flumotion.twisted.pb.Avatar-class.html#remoteLogName">remoteLogName</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.spread.pb.Avatar</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="haveMind"></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">haveMind</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="flumotion.worker.job-pysrc.html#ComponentJobAvatar.haveMind">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Overrides:
        <a href="flumotion.worker.base.BaseJobAvatar-class.html#haveMind">base.BaseJobAvatar.haveMind</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="stop"></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">stop</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="flumotion.worker.job-pysrc.html#ComponentJobAvatar.stop">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>returns: a deferred marking completed stop.</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="flumotion.worker.base.BaseJobAvatar-class.html#stop">base.BaseJobAvatar.stop</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="sendFeed"></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">sendFeed</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">feedName</span>,
        <span class="sig-arg">fd</span>,
        <span class="sig-arg">eaterId</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="flumotion.worker.job-pysrc.html#ComponentJobAvatar.sendFeed">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Tell the feeder to send the given feed to the given fd.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>whether the fd was successfully handed off to the component.</dd>
  </dl>
</td></tr></table>
</div>
<a name="receiveFeed"></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">receiveFeed</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">eaterAlias</span>,
        <span class="sig-arg">fd</span>,
        <span class="sig-arg">feedId</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="flumotion.worker.job-pysrc.html#ComponentJobAvatar.receiveFeed">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Tell the feeder to receive the given feed from the given fd.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>whether the fd was successfully handed off to the component.</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>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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:16 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>