<?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.admin.assistant.interfaces.IHTTPConsumerPlugin</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.admin-module.html">Package admin</a> :: <a href="flumotion.admin.assistant-module.html">Package assistant</a> :: <a href="flumotion.admin.assistant.interfaces-module.html">Module interfaces</a> :: Class IHTTPConsumerPlugin </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 IHTTPConsumerPlugin</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.admin.assistant.interfaces-pysrc.html#IHTTPConsumerPlugin">source code</a></span></p> <pre class="base-tree"> zope.interface.Interface --+ | <strong class="uidshort">IHTTPConsumerPlugin</strong> </pre> <hr /> <p>A http consumer plugin is how you extend the HTTP consumer page. The main purpose of the plugin is to get a consumer model (eg, a http server) specific for this plugin. This entry point should be defined in the xml for the component under the entry type "wizard".</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.admin.assistant.interfaces.IHTTPConsumerPlugin-class.html#__call__" class="summary-sig-name">__call__</a>(<span class="summary-sig-arg">assistant</span>)</span><br /> Creates http consumer plugins</td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.admin.assistant.interfaces-pysrc.html#IHTTPConsumerPlugin.__call__">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.admin.assistant.interfaces.IHTTPConsumerPlugin-class.html#workerChanged" class="summary-sig-name">workerChanged</a>(<span class="summary-sig-arg">worker</span>)</span><br /> Called when the worker for the step changed.</td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.admin.assistant.interfaces-pysrc.html#IHTTPConsumerPlugin.workerChanged">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">a <a href="flumotion.admin.assistant.models.HTTPServer-class.html" class="link">HTTPServer</a> subclass</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="flumotion.admin.assistant.interfaces.IHTTPConsumerPlugin-class.html#getConsumer" class="summary-sig-name">getConsumer</a>(<span class="summary-sig-arg">streamer</span>, <span class="summary-sig-arg">audio_producer</span>, <span class="summary-sig-arg">video_producer</span>)</span><br /> Asks the plugin for a consumer model</td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.admin.assistant.interfaces-pysrc.html#IHTTPConsumerPlugin.getConsumer">source code</a></span> </td> </tr> </table> </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 class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="flumotion.admin.assistant.interfaces.IHTTPConsumerPlugin-class.html#_InterfaceClass__attrs" class="summary-name" onclick="show_private();">_InterfaceClass__attrs</a> = <code title="{'__call__': <zope.interface.interface.Method object at 0x23ed610>, 'getConsumer': <zope.interface.interface.Method object at 0x23ed650>, 'workerChanged': <zope.interface.interface.Method object at 0x23ed690\ >}"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">__call__</code><code class="variable-quote">'</code><code class="variable-op">: </code><zope.interface.interfac<code class="variable-ellipsis">...</code></code> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="__bases__"></a><span class="summary-name">__bases__</span> = <code title="(<InterfaceClass zope.interface.Interface>)"><code class="variable-group">(</code><InterfaceClass zope.interface.Interface><code class="variable-group">)</code></code> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="flumotion.admin.assistant.interfaces.IHTTPConsumerPlugin-class.html#__identifier__" class="summary-name">__identifier__</a> = <code title="'flumotion.admin.assistant.interfaces.IHTTPConsumerPlugin'"><code class="variable-quote">'</code><code class="variable-string">flumotion.admin.assistant.interfaces.IHTTPCo</code><code class="variable-ellipsis">...</code></code> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="flumotion.admin.assistant.interfaces.IHTTPConsumerPlugin-class.html#__iro__" class="summary-name">__iro__</a> = <code title="(<InterfaceClass flumotion.admin.assistant.interfaces.IHTTPConsumerPlu\ gin>, <InterfaceClass zope.interface.Interface>)"><code class="variable-group">(</code><InterfaceClass flumotion.admin.assistant.interface<code class="variable-ellipsis">...</code></code> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="__name__"></a><span class="summary-name">__name__</span> = <code title="'IHTTPConsumerPlugin'"><code class="variable-quote">'</code><code class="variable-string">IHTTPConsumerPlugin</code><code class="variable-quote">'</code></code> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="flumotion.admin.assistant.interfaces.IHTTPConsumerPlugin-class.html#__sro__" class="summary-name">__sro__</a> = <code title="(<InterfaceClass flumotion.admin.assistant.interfaces.IHTTPConsumerPlu\ gin>, <InterfaceClass zope.interface.Interface>)"><code class="variable-group">(</code><InterfaceClass flumotion.admin.assistant.interface<code class="variable-ellipsis">...</code></code> </td> </tr> <tr class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="flumotion.admin.assistant.interfaces.IHTTPConsumerPlugin-class.html#_implied" class="summary-name" onclick="show_private();">_implied</a> = <code title="{<InterfaceClass flumotion.admin.assistant.interfaces.IHTTPConsumerPlu\ gin>: (), <InterfaceClass zope.interface.Interface>: ()}"><code class="variable-group">{</code><InterfaceClass flumotion.admin.assistant.interfac<code class="variable-ellipsis">...</code></code> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="dependents"></a><span class="summary-name">dependents</span> = <code title="<WeakKeyDictionary at 37670712>"><WeakKeyDictionary at 37670712></code> </td> </tr> <tr> <td colspan="2" class="summary"> <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>zope.interface.Interface</code></b> (private): <code>_Element__tagged_values</code> </p></div> </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="__call__"></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">__call__</span>(<span class="sig-arg">assistant</span>)</span> <br /><em class="fname">(Call operator)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="flumotion.admin.assistant.interfaces-pysrc.html#IHTTPConsumerPlugin.__call__">source code</a></span> </td> </tr></table> <p>Creates http consumer plugins</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>assistant</code></strong> (<a href="flumotion.admin.gtk.configurationassistant.ConfigurationAssistant-class.html" class="link">ConfigurationAssistant</a>) - the assistant</li> </ul></dd> </dl> </td></tr></table> </div> <a name="workerChanged"></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">workerChanged</span>(<span class="sig-arg">worker</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="flumotion.admin.assistant.interfaces-pysrc.html#IHTTPConsumerPlugin.workerChanged">source code</a></span> </td> </tr></table> <p>Called when the worker for the step changed.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>worker</code></strong> (<a href="flumotion.common.componentui.WorkerComponentUIState-class.html" class="link">WorkerComponentUIState</a>) - the worker</li> </ul></dd> </dl> </td></tr></table> </div> <a name="getConsumer"></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">getConsumer</span>(<span class="sig-arg">streamer</span>, <span class="sig-arg">audio_producer</span>, <span class="sig-arg">video_producer</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="flumotion.admin.assistant.interfaces-pysrc.html#IHTTPConsumerPlugin.getConsumer">source code</a></span> </td> </tr></table> <p>Asks the plugin for a consumer model</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>streamer</code></strong> (<code class="link">HTTPStreamer</code> subclass) - the http streamer</li> <li><strong class="pname"><code>audio_producer</code></strong> (<a href="flumotion.admin.assistant.models.AudioProducer-class.html" class="link">AudioProducer</a> subclass) - audio producer for this stream</li> <li><strong class="pname"><code>video_producer</code></strong> (<a href="flumotion.admin.assistant.models.VideoProducer-class.html" class="link">VideoProducer</a> subclass) - video producer for this stream</li> </ul></dd> <dt>Returns: a <a href="flumotion.admin.assistant.models.HTTPServer-class.html" class="link">HTTPServer</a> subclass</dt> <dd>consumer</dd> </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="_InterfaceClass__attrs"></a> <div class="private"> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <h3 class="epydoc">_InterfaceClass__attrs</h3> <dl class="fields"> </dl> <dl class="fields"> <dt>Value:</dt> <dd><table><tr><td><pre class="variable"> <code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">__call__</code><code class="variable-quote">'</code><code class="variable-op">: </code><zope.interface.interface.Method object at 0x23ed610><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">getConsumer</code><code class="variable-quote">'</code><code class="variable-op">: </code><zope.interface.interface.Method object at 0x23ed650><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">workerChanged</code><code class="variable-quote">'</code><code class="variable-op">: </code><zope.interface.interface.Method object at 0x23ed690<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> ><code class="variable-group">}</code> </pre></td></tr></table> </dd> </dl> </td></tr></table> </div> <a name="__identifier__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <h3 class="epydoc">__identifier__</h3> <dl class="fields"> </dl> <dl class="fields"> <dt>Value:</dt> <dd><table><tr><td><pre class="variable"> <code class="variable-quote">'</code><code class="variable-string">flumotion.admin.assistant.interfaces.IHTTPConsumerPlugin</code><code class="variable-quote">'</code> </pre></td></tr></table> </dd> </dl> </td></tr></table> </div> <a name="__iro__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <h3 class="epydoc">__iro__</h3> <dl class="fields"> </dl> <dl class="fields"> <dt>Value:</dt> <dd><table><tr><td><pre class="variable"> <code class="variable-group">(</code><InterfaceClass flumotion.admin.assistant.interfaces.IHTTPConsumerPlu<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> gin><code class="variable-op">,</code> <InterfaceClass zope.interface.Interface><code class="variable-group">)</code> </pre></td></tr></table> </dd> </dl> </td></tr></table> </div> <a name="__sro__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <h3 class="epydoc">__sro__</h3> <dl class="fields"> </dl> <dl class="fields"> <dt>Value:</dt> <dd><table><tr><td><pre class="variable"> <code class="variable-group">(</code><InterfaceClass flumotion.admin.assistant.interfaces.IHTTPConsumerPlu<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> gin><code class="variable-op">,</code> <InterfaceClass zope.interface.Interface><code class="variable-group">)</code> </pre></td></tr></table> </dd> </dl> </td></tr></table> </div> <a name="_implied"></a> <div class="private"> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <h3 class="epydoc">_implied</h3> <dl class="fields"> </dl> <dl class="fields"> <dt>Value:</dt> <dd><table><tr><td><pre class="variable"> <code class="variable-group">{</code><InterfaceClass flumotion.admin.assistant.interfaces.IHTTPConsumerPlu<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> gin><code class="variable-op">: </code><code class="variable-group">(</code><code class="variable-group">)</code><code class="variable-op">,</code> <InterfaceClass zope.interface.Interface><code class="variable-op">: </code><code class="variable-group">(</code><code class="variable-group">)</code><code class="variable-group">}</code> </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 Sun Sep 13 13:13:58 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>