<?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.medium.WorkerClientFactory</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.worker-module.html">Package worker</a> :: <a href="flumotion.worker.medium-module.html">Module medium</a> :: Class WorkerClientFactory </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 WorkerClientFactory</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerClientFactory">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> --+ | <a href="flumotion.twisted.pb.FPBClientFactory-class.html">twisted.pb.FPBClientFactory</a> --+ | twisted.internet.protocol.Factory --+ | | | twisted.internet.protocol.ClientFactory --+ | | | twisted.internet.protocol.ReconnectingClientFactory --+ | <a href="flumotion.twisted.pb.ReconnectingFPBClientFactory-class.html">twisted.pb.ReconnectingFPBClientFactory</a> --+ | <strong class="uidshort">WorkerClientFactory</strong> </pre> <hr /> <p>I am a client factory for the worker to log in to the manager.</p> <!-- ==================== 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 width="15%" align="right" valign="top" class="summary"> <span class="summary-type">subclass of <a href="flumotion.common.interfaces.IMedium-class.html" class="link">flumotion.common.interfaces.IMedium</a></span> </td><td class="summary"> <a href="flumotion.common.interfaces.IWorkerMedium-class.html" class="summary-name">perspectiveInterface</a><br /> the interface we want to request a perspective for </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.worker.medium.WorkerClientFactory-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">medium</span>, <span class="summary-sig-arg">host</span>, <span class="summary-sig-arg">port</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerClientFactory.__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.worker.medium.WorkerClientFactory-class.html#clientConnectionFailed" class="summary-sig-name">clientConnectionFailed</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">connector</span>, <span class="summary-sig-arg">reason</span>)</span><br /> Called when a connection has failed to connect.</td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerClientFactory.clientConnectionFailed">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.worker.medium.WorkerClientFactory-class.html#gotDeferredLogin" class="summary-sig-name">gotDeferredLogin</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">d</span>)</span><br /> The deferred from login is now available.</td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerClientFactory.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.twisted.pb.ReconnectingFPBClientFactory-class.html">twisted.pb.ReconnectingFPBClientFactory</a></code></b>: <code><a href="flumotion.twisted.pb.ReconnectingFPBClientFactory-class.html#clientConnectionLost">clientConnectionLost</a></code>, <code><a href="flumotion.twisted.pb.ReconnectingFPBClientFactory-class.html#clientConnectionMade">clientConnectionMade</a></code>, <code><a href="flumotion.twisted.pb.ReconnectingFPBClientFactory-class.html#startLogin">startLogin</a></code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.twisted.pb.FPBClientFactory-class.html">twisted.pb.FPBClientFactory</a></code></b>: <code><a href="flumotion.twisted.pb.FPBClientFactory-class.html#disconnect">disconnect</a></code>, <code><a href="flumotion.twisted.pb.FPBClientFactory-class.html#getKeycardClasses">getKeycardClasses</a></code>, <code><a href="flumotion.twisted.pb.FPBClientFactory-class.html#login">login</a></code>, <code><a href="flumotion.twisted.pb.FPBClientFactory-class.html#startedConnecting">startedConnecting</a></code> </p> <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.twisted.pb.FPBClientFactory-class.html">twisted.pb.FPBClientFactory</a></code></b> (private): <code><a href="flumotion.twisted.pb.FPBClientFactory-class.html#_cbLoginCallback" onclick="show_private();">_cbLoginCallback</a></code>, <code><a href="flumotion.twisted.pb.FPBClientFactory-class.html#_cbSendKeycard" onclick="show_private();">_cbSendKeycard</a></code>, <code><a href="flumotion.twisted.pb.FPBClientFactory-class.html#_cbSendUsername" onclick="show_private();">_cbSendUsername</a></code> </p></div> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.spread.pb.PBClientFactory</code></b>: <code>buildProtocol</code>, <code>getPerspective</code>, <code>getRootObject</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>_failAll</code>, <code>_reset</code> </p></div> <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 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="'worker'"><code class="variable-quote">'</code><code class="variable-string">worker</code><code class="variable-quote">'</code></code><br /> Implementors can provide a category to log their messages under. </td> </tr> <tr> <td colspan="2" class="summary"> <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.twisted.pb.FPBClientFactory-class.html">twisted.pb.FPBClientFactory</a></code></b> (private): <code><a href="flumotion.twisted.pb.FPBClientFactory-class.html#_fpbconnector" onclick="show_private();">_fpbconnector</a></code> </p></div> <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>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><a href="flumotion.twisted.pb.FPBClientFactory-class.html">twisted.pb.FPBClientFactory</a></code></b>: <code><a href="flumotion.twisted.pb.FPBClientFactory-class.html#keycard">keycard</a></code>, <code><a href="flumotion.twisted.pb.FPBClientFactory-class.html#medium">medium</a></code> </p> <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">medium</span>, <span class="sig-arg">host</span>, <span class="sig-arg">port</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerClientFactory.__init__">source code</a></span> </td> </tr></table> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>unsafeTracebacks</code></strong> - if set, tracebacks for exceptions will be sent over the wire.</li> <li><strong class="pname"><code>security</code></strong> - security options used by the broker, default to <code>globalSecurity</code>.</li> <li><strong class="pname"><code>host</code></strong> (str)</li> <li><strong class="pname"><code>medium</code></strong> (<a href="flumotion.worker.medium.WorkerMedium-class.html" class="link">flumotion.worker.medium.WorkerMedium</a>)</li> <li><strong class="pname"><code>port</code></strong> (int)</li> </ul></dd> <dt>Overrides: twisted.spread.pb.PBClientFactory.__init__ </dt> </dl> </td></tr></table> </div> <a name="clientConnectionFailed"></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">clientConnectionFailed</span>(<span class="sig-arg">self</span>, <span class="sig-arg">connector</span>, <span class="sig-arg">reason</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerClientFactory.clientConnectionFailed">source code</a></span> </td> </tr></table> <p>Called when a connection has failed to connect.</p> <p>It may be useful to call connector.connect() - this will reconnect.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>reason</code></strong> - <code class="link">twisted.spread.pb.failure.Failure</code></li> </ul></dd> <dt>Overrides: twisted.internet.protocol.ReconnectingClientFactory.clientConnectionFailed </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">d</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="flumotion.worker.medium-pysrc.html#WorkerClientFactory.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.ReconnectingFPBClientFactory-class.html#gotDeferredLogin">twisted.pb.ReconnectingFPBClientFactory.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: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>