<?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.plugs.base.ComponentPlug</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.plugs-module.html">Package plugs</a> :: <a href="flumotion.component.plugs.base-module.html">Module base</a> :: Class ComponentPlug </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 ComponentPlug</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.component.plugs.base-pysrc.html#ComponentPlug">source code</a></span></p> <pre class="base-tree"> <a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a> --+ | <a href="flumotion.component.plugs.base.Plug-class.html">Plug</a> --+ | <strong class="uidshort">ComponentPlug</strong> </pre> <dl><dt>Known Subclasses:</dt> <dd> <ul class="subclass-list"> <li><a href="flumotion.component.bouncers.plug.BouncerPlug-class.html">bouncers.plug.BouncerPlug</a></li><li>, <a href="flumotion.component.misc.httpserver.ratecontrol.RateControllerPlug-class.html">misc.httpserver.ratecontrol.RateControllerPlug</a></li><li>, <a href="flumotion.component.misc.httpserver.fileprovider.FileProviderPlug-class.html">misc.httpserver.fileprovider.FileProviderPlug</a></li><li>, <a href="flumotion.component.misc.httpserver.metadataprovider.MetadataProviderPlug-class.html">misc.httpserver.metadataprovider.MetadataProviderPlug</a></li><li>, <a href="flumotion.component.combiners.switch.switch.ICalSwitchPlug-class.html">combiners.switch.switch.ICalSwitchPlug</a></li><li>, <a href="flumotion.component.plugs.requestmodifier.RequestModifierPlug-class.html">requestmodifier.RequestModifierPlug</a></li><li>, <a href="flumotion.component.plugs.streamdata.StreamDataProviderPlug-class.html">streamdata.StreamDataProviderPlug</a></li><li>, <a href="flumotion.component.plugs.request.RequestLoggerPlug-class.html">request.RequestLoggerPlug</a></li><li>, <a href="flumotion.component.plugs.base.ComponentExamplePlug-class.html">ComponentExamplePlug</a></li><li>, <a href="flumotion.component.plugs.rrd.ComponentRRDPlug-class.html">rrd.ComponentRRDPlug</a></li><li>, <a href="flumotion.component.plugs.cortado.cortado.ComponentCortadoPlug-class.html">cortado.cortado.ComponentCortadoPlug</a></li><li>, <a href="flumotion.component.consumers.disker.disker_plug.DiskerPlug-class.html">consumers.disker.disker_plug.DiskerPlug</a></li> </ul> </dd></dl> <hr /> <p>Base class for plugs that live in a component. Subclasses can implement the start and stop vmethods, which will be called with the component as an argument.</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 name="start"></a><span class="summary-sig-name">start</span>(<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.plugs.base-pysrc.html#ComponentPlug.start">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="stop"></a><span class="summary-sig-name">stop</span>(<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.plugs.base-pysrc.html#ComponentPlug.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="restart"></a><span class="summary-sig-name">restart</span>(<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.plugs.base-pysrc.html#ComponentPlug.restart">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.component.plugs.base.Plug-class.html">Plug</a></code></b>: <code><a href="flumotion.component.plugs.base.Plug-class.html#__init__">__init__</a></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.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a></code></b>: <code><a href="flumotion.extern.log.log.Loggable-class.html#logCategory">logCategory</a></code> </p> </td> </tr> </table> <!-- ==================== 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:10 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>