<?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.misc.porter.porterclient.HTTPPorterClientFactory</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.misc-module.html">Package misc</a> :: <a href="flumotion.component.misc.porter-module.html">Package porter</a> :: <a href="flumotion.component.misc.porter.porterclient-module.html">Module porterclient</a> :: Class HTTPPorterClientFactory </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 HTTPPorterClientFactory</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.component.misc.porter.porterclient-pysrc.html#HTTPPorterClientFactory">source code</a></span></p> <pre class="base-tree"> twisted.internet.protocol.Factory --+ | twisted.internet.protocol.ClientFactory --+ | twisted.spread.pb.PBClientFactory --+ | <a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a> --+ | twisted.internet.protocol.Factory --+ | | | twisted.internet.protocol.ClientFactory --+ | | | twisted.internet.protocol.ReconnectingClientFactory --+ | <a href="flumotion.twisted.pb.ReconnectingPBClientFactory-class.html">twisted.pb.ReconnectingPBClientFactory</a> --+ | <a href="flumotion.component.misc.porter.porterclient.PorterClientFactory-class.html">PorterClientFactory</a> --+ | <strong class="uidshort">HTTPPorterClientFactory</strong> </pre> <hr /> <!-- ==================== NESTED CLASSES ==================== --> <a name="section-NestedClasses"></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">Nested Classes</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-NestedClasses" 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>twisted.spread.pb.PBClientFactory</code></b>: <code><a href="twisted.spread.pb.Broker-class.html">protocol</a></code> </p> </td> </tr> </table> <!-- ==================== 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.misc.porter.porterclient.HTTPPorterClientFactory-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">childFactory</span>, <span class="summary-sig-arg">mountPoints</span>, <span class="summary-sig-arg">do_start_deferred</span>, <span class="summary-sig-arg">prefixes</span>=<span class="summary-sig-default">None</span>)</span><br /> Create a PorterClientFactory that will use childFactory to create protocol instances for clients attached to the FDs received over this connection.</td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.component.misc.porter.porterclient-pysrc.html#HTTPPorterClientFactory.__init__">source code</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"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="_fireDeferred"></a><span class="summary-sig-name">_fireDeferred</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">r</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.component.misc.porter.porterclient-pysrc.html#HTTPPorterClientFactory._fireDeferred">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.misc.porter.porterclient.HTTPPorterClientFactory-class.html#gotDeferredLogin" class="summary-sig-name">gotDeferredLogin</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">deferred</span>)</span><br /> The deferred from login is now available.</td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.component.misc.porter.porterclient-pysrc.html#HTTPPorterClientFactory.gotDeferredLogin">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.misc.porter.porterclient.PorterClientFactory-class.html">PorterClientFactory</a></code></b>: <code><a href="flumotion.component.misc.porter.porterclient.PorterClientFactory-class.html#buildProtocol">buildProtocol</a></code>, <code><a href="flumotion.component.misc.porter.porterclient.PorterClientFactory-class.html#deregisterDefault">deregisterDefault</a></code>, <code><a href="flumotion.component.misc.porter.porterclient.PorterClientFactory-class.html#deregisterPath">deregisterPath</a></code>, <code><a href="flumotion.component.misc.porter.porterclient.PorterClientFactory-class.html#deregisterPrefix">deregisterPrefix</a></code>, <code><a href="flumotion.component.misc.porter.porterclient.PorterClientFactory-class.html#registerDefault">registerDefault</a></code>, <code><a href="flumotion.component.misc.porter.porterclient.PorterClientFactory-class.html#registerPath">registerPath</a></code>, <code><a href="flumotion.component.misc.porter.porterclient.PorterClientFactory-class.html#registerPrefix">registerPrefix</a></code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.twisted.pb.ReconnectingPBClientFactory-class.html">twisted.pb.ReconnectingPBClientFactory</a></code></b>: <code><a href="flumotion.twisted.pb.ReconnectingPBClientFactory-class.html#clientConnectionFailed">clientConnectionFailed</a></code>, <code><a href="flumotion.twisted.pb.ReconnectingPBClientFactory-class.html#clientConnectionLost">clientConnectionLost</a></code>, <code><a href="flumotion.twisted.pb.ReconnectingPBClientFactory-class.html#clientConnectionMade">clientConnectionMade</a></code>, <code><a href="flumotion.twisted.pb.ReconnectingPBClientFactory-class.html#startLogin">startLogin</a></code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.spread.pb.PBClientFactory</code></b>: <code>disconnect</code>, <code>getPerspective</code>, <code>getRootObject</code>, <code>login</code> </p> <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.spread.pb.PBClientFactory</code></b> (private): <code>_cbLoginAnonymous</code>, <code>_cbResponse</code>, <code>_cbSendUsername</code>, <code>_failAll</code>, <code>_reset</code> </p></div> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.protocol.ClientFactory</code></b>: <code>startedConnecting</code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.protocol.Factory</code></b>: <code>__providedBy__</code>, <code>doStart</code>, <code>doStop</code>, <code>startFactory</code>, <code>stopFactory</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> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.protocol.ReconnectingClientFactory</code></b>: <code>__getstate__</code>, <code>resetDelay</code>, <code>retry</code>, <code>stopTrying</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>twisted.spread.pb.PBClientFactory</code></b>: <code>unsafeTracebacks</code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.protocol.Factory</code></b>: <code>__implemented__</code>, <code>__provides__</code>, <code>noisy</code>, <code>numPorts</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#logCategory">logCategory</a></code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.protocol.ReconnectingClientFactory</code></b>: <code>connector</code>, <code>continueTrying</code>, <code>delay</code>, <code>maxRetries</code>, <code>retries</code> </p> <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.protocol.ReconnectingClientFactory</code></b> (private): <code>_callID</code> </p></div> </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>twisted.internet.protocol.ReconnectingClientFactory</code></b>: <code>factor</code>, <code>initialDelay</code>, <code>jitter</code>, <code>maxDelay</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">childFactory</span>, <span class="sig-arg">mountPoints</span>, <span class="sig-arg">do_start_deferred</span>, <span class="sig-arg">prefixes</span>=<span class="sig-default">None</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="flumotion.component.misc.porter.porterclient-pysrc.html#HTTPPorterClientFactory.__init__">source code</a></span> </td> </tr></table> <p>Create a PorterClientFactory that will use childFactory to create protocol instances for clients attached to the FDs received over this connection.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>mountPoints</code></strong> - a list of mountPoint strings that should be registered to the porter</li> </ul></dd> <dt>Overrides: twisted.spread.pb.PBClientFactory.__init__ </dt> </dl> </td></tr></table> </div> <a name="gotDeferredLogin"></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">gotDeferredLogin</span>(<span class="sig-arg">self</span>, <span class="sig-arg">deferred</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="flumotion.component.misc.porter.porterclient-pysrc.html#HTTPPorterClientFactory.gotDeferredLogin">source code</a></span> </td> </tr></table> <p>The deferred from login is now available.</p> <dl class="fields"> <dt>Overrides: <a href="flumotion.twisted.pb.ReconnectingPBClientFactory-class.html#gotDeferredLogin">twisted.pb.ReconnectingPBClientFactory.gotDeferredLogin</a> <dd><em class="note">(inherited documentation)</em></dd> </dt> </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: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>