Sophie

Sophie

distrib > Mandriva > 2010.1 > x86_64 > media > contrib-release > by-pkgid > 2eca861f24be6048290ed27335ec22aa > files > 1315

flumotion-doc-0.6.1-1mdv2010.0.x86_64.rpm

<?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.rtsp.RTSPChannel</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>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;flumotion ::
        <a href="flumotion.twisted-module.html">Package&nbsp;twisted</a> ::
        <a href="flumotion.twisted.rtsp-module.html">Module&nbsp;rtsp</a> ::
        Class&nbsp;RTSPChannel
      </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&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class RTSPChannel</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.twisted.rtsp-pysrc.html#RTSPChannel">source&nbsp;code</a></span></p>
<pre class="base-tree">
twisted.internet.protocol.BaseProtocol --+            
                                         |            
        twisted.internet.protocol.Protocol --+        
                                             |        
   twisted.protocols.basic._PauseableMixin --+        
                                             |        
          twisted.protocols.basic.LineReceiver --+    
                                                 |    
       twisted.protocols.policies.TimeoutMixin --+    
                                                 |    
                      <a href="twisted.web.http.HTTPChannel-class.html">twisted.web.http.HTTPChannel</a> --+
                                                     |
                                                    <strong class="uidshort">RTSPChannel</strong>
</pre>

<hr />
<p>A receiver for HTTP requests.</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">&nbsp;</span>
    </td><td class="summary">
        <a href="flumotion.twisted.rtsp.RTSPRequest-class.html" class="summary-name">requestFactory</a><br />
      A HTTP request.
    </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"><code>bool</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="flumotion.twisted.rtsp.RTSPChannel-class.html#checkPersistence" class="summary-sig-name">checkPersistence</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">request</span>,
        <span class="summary-sig-arg">version</span>)</span><br />
      Check if the channel should close or not.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="flumotion.twisted.rtsp-pysrc.html#RTSPChannel.checkPersistence">source&nbsp;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.web.http.HTTPChannel-class.html">twisted.web.http.HTTPChannel</a></code></b>:
      <code><a href="twisted.web.http.HTTPChannel-class.html#__init__">__init__</a></code>,
      <code><a href="twisted.web.http.HTTPChannel-class.html#allContentReceived">allContentReceived</a></code>,
      <code><a href="twisted.web.http.HTTPChannel-class.html#allHeadersReceived">allHeadersReceived</a></code>,
      <code><a href="twisted.web.http.HTTPChannel-class.html#connectionLost">connectionLost</a></code>,
      <code><a href="twisted.web.http.HTTPChannel-class.html#connectionMade">connectionMade</a></code>,
      <code><a href="twisted.web.http.HTTPChannel-class.html#headerReceived">headerReceived</a></code>,
      <code><a href="twisted.web.http.HTTPChannel-class.html#lineReceived">lineReceived</a></code>,
      <code><a href="twisted.web.http.HTTPChannel-class.html#rawDataReceived">rawDataReceived</a></code>,
      <code><a href="twisted.web.http.HTTPChannel-class.html#requestDone">requestDone</a></code>,
      <code><a href="twisted.web.http.HTTPChannel-class.html#timeoutConnection">timeoutConnection</a></code>
      </p>
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="twisted.web.http.HTTPChannel-class.html">twisted.web.http.HTTPChannel</a></code></b> (private):
      <code><a href="twisted.web.http.HTTPChannel-class.html#_finishRequestBody" onclick="show_private();">_finishRequestBody</a></code>
      </p></div>
    <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.protocols.basic.LineReceiver</code></b>:
      <code>clearLineBuffer</code>,
      <code>dataReceived</code>,
      <code>lineLengthExceeded</code>,
      <code>sendLine</code>,
      <code>setLineMode</code>,
      <code>setRawMode</code>
      </p>
    <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.protocols.basic._PauseableMixin</code></b>:
      <code>pauseProducing</code>,
      <code>resumeProducing</code>,
      <code>stopProducing</code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.protocols.policies.TimeoutMixin</code></b>:
      <code>callLater</code>,
      <code>resetTimeout</code>,
      <code>setTimeout</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.web.http.HTTPChannel-class.html">twisted.web.http.HTTPChannel</a></code></b>:
      <code><a href="twisted.web.http.HTTPChannel-class.html#length">length</a></code>,
      <code><a href="twisted.web.http.HTTPChannel-class.html#maxHeaders">maxHeaders</a></code>,
      <code><a href="twisted.web.http.HTTPChannel-class.html#persistent">persistent</a></code>
      </p>
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="twisted.web.http.HTTPChannel-class.html">twisted.web.http.HTTPChannel</a></code></b> (private):
      <code><a href="twisted.web.http.HTTPChannel-class.html#_receivedHeaderCount" onclick="show_private();">_receivedHeaderCount</a></code>,
      <code><a href="twisted.web.http.HTTPChannel-class.html#_savedTimeOut" onclick="show_private();">_savedTimeOut</a></code>
      </p></div>
    <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.protocols.basic.LineReceiver</code></b>:
      <code>MAX_LENGTH</code>,
      <code>delimiter</code>,
      <code>line_mode</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>twisted.protocols.basic._PauseableMixin</code></b>:
      <code>paused</code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.protocols.policies.TimeoutMixin</code></b>:
      <code>timeOut</code>
      </p>
    </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">
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="twisted.web.http.HTTPChannel-class.html">twisted.web.http.HTTPChannel</a></code></b> (private):
      <code><a href="twisted.web.http.HTTPChannel-class.html#_transferDecoder" onclick="show_private();">_transferDecoder</a></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="checkPersistence"></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">checkPersistence</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">request</span>,
        <span class="sig-arg">version</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="flumotion.twisted.rtsp-pysrc.html#RTSPChannel.checkPersistence">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Check if the channel should close or not.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>request</code></strong> - The request most recently received over this channel against 
          which checks will be made to determine if this connection can 
          remain open after a matching response is returned.</li>
        <li><strong class="pname"><code>version</code></strong> - The version of the request.</li>
    </ul></dd>
    <dt>Returns: <code>bool</code></dt>
        <dd>A flag which, if <code>True</code>, indicates that this 
          connection may remain open to receive another request; if 
          <code>False</code>, the connection must be closed in order to 
          indicate the completion of the response to <code>request</code>.</dd>
    <dt>Overrides:
        twisted.web.http.HTTPChannel.checkPersistence
        <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>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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>