<?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.twisted.fdserver.FDPassingBroker</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.twisted-module.html">Package twisted</a> :: <a href="flumotion.twisted.fdserver-module.html">Module fdserver</a> :: Class FDPassingBroker </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 FDPassingBroker</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.twisted.fdserver-pysrc.html#FDPassingBroker">source code</a></span></p> <pre class="base-tree"> twisted.internet.protocol.BaseProtocol --+ | twisted.internet.protocol.Protocol --+ | twisted.persisted.styles.Ephemeral --+ | twisted.spread.banana.Banana --+ | <a href="twisted.spread.pb.Broker-class.html">twisted.spread.pb.Broker</a> --+ | <a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a> --+ | <strong class="uidshort">FDPassingBroker</strong> </pre> <hr /> <p>A pb.Broker subclass that handles FDs being passed to it (with associated data) over the same connection as the normal PB data stream. When an FD is seen, it creates new protocol objects for them from the childFactory attribute.</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.twisted.fdserver.FDPassingBroker-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">connectionClass</span>, <span class="summary-sig-arg">**kwargs</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.twisted.fdserver-pysrc.html#FDPassingBroker.__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 name="fileDescriptorsReceived"></a><span class="summary-sig-name">fileDescriptorsReceived</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">fds</span>, <span class="summary-sig-arg">message</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.twisted.fdserver-pysrc.html#FDPassingBroker.fileDescriptorsReceived">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="twisted.spread.pb.Broker-class.html">twisted.spread.pb.Broker</a></code></b>: <code><a href="twisted.spread.pb.Broker-class.html#cacheLocally">cacheLocally</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#cacheRemotely">cacheRemotely</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#cachedLocallyAs">cachedLocallyAs</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#cachedRemotelyAs">cachedRemotelyAs</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#connectionFailed">connectionFailed</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#connectionLost">connectionLost</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#connectionReady">connectionReady</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#decCacheRef">decCacheRef</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#dontNotifyOnDisconnect">dontNotifyOnDisconnect</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#expressionReceived">expressionReceived</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#localObjectForID">localObjectForID</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#newLocalID">newLocalID</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#newRequestID">newRequestID</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#notifyOnConnect">notifyOnConnect</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#notifyOnDisconnect">notifyOnDisconnect</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#notifyOnFail">notifyOnFail</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#pauseProducing">pauseProducing</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#proto_answer">proto_answer</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#proto_cachemessage">proto_cachemessage</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#proto_decache">proto_decache</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#proto_decref">proto_decref</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#proto_didNotUnderstand">proto_didNotUnderstand</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#proto_error">proto_error</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#proto_message">proto_message</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#proto_uncache">proto_uncache</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#proto_version">proto_version</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#registerPageProducer">registerPageProducer</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#registerReference">registerReference</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#remoteForName">remoteForName</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#remotelyCachedForLUID">remotelyCachedForLUID</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#resumeProducing">resumeProducing</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#sendCall">sendCall</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#sendDecRef">sendDecRef</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#serialize">serialize</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#setNameForLocal">setNameForLocal</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#stopProducing">stopProducing</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#unserialize">unserialize</a></code> </p> <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="twisted.spread.pb.Broker-class.html">twisted.spread.pb.Broker</a></code></b> (private): <code><a href="twisted.spread.pb.Broker-class.html#_recvMessage" onclick="show_private();">_recvMessage</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#_sendAnswer" onclick="show_private();">_sendAnswer</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#_sendError" onclick="show_private();">_sendError</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#_sendFailure" onclick="show_private();">_sendFailure</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#_sendFailureOrError" onclick="show_private();">_sendFailureOrError</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#_sendMessage" onclick="show_private();">_sendMessage</a></code> </p></div> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.spread.banana.Banana</code></b>: <code>callExpressionReceived</code>, <code>connectionMade</code>, <code>dataReceived</code>, <code>gotItem</code>, <code>sendEncoded</code>, <code>setPrefixLimit</code> </p> <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.spread.banana.Banana</code></b> (private): <code>_encode</code>, <code>_selectDialect</code> </p></div> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.protocol.BaseProtocol</code></b>: <code>__providedBy__</code>, <code>makeConnection</code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.persisted.styles.Ephemeral</code></b>: <code>__getstate__</code>, <code>__setstate__</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="twisted.spread.pb.Broker-class.html">twisted.spread.pb.Broker</a></code></b>: <code><a href="twisted.spread.pb.Broker-class.html#factory">factory</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#maxBrokerRefsViolations">maxBrokerRefsViolations</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#username">username</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#version">version</a></code>, <code><a href="twisted.spread.pb.Broker-class.html#waitingForAnswers">waitingForAnswers</a></code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.spread.banana.Banana</code></b>: <code>buffer</code>, <code>incomingVocabulary</code>, <code>k</code>, <code>knownDialects</code>, <code>outgoingVocabulary</code>, <code>prefixLimit</code>, <code>sizeLimit</code>, <code>v</code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.protocol.Protocol</code></b>: <code>__implemented__</code>, <code>__provides__</code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.protocol.BaseProtocol</code></b>: <code>connected</code>, <code>transport</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> </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">connectionClass</span>, <span class="sig-arg">**kwargs</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="flumotion.twisted.fdserver-pysrc.html#FDPassingBroker.__init__">source code</a></span> </td> </tr></table> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>connectionClass</code></strong> - subclass of <code class="link">twisted.internet.tcp.Connection</code></li> </ul></dd> <dt>Overrides: twisted.spread.banana.Banana.__init__ </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:15 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>