twisted.protocols.basic.LineReceiver-class.html
fb50ed06a412master

twisted.protocols.basic.LineReceiver-class.html
View Options

			<?xml version="1.0" encoding="iso-8859-1"?>
			<!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>twisted.protocols.basic.LineReceiver</title>
			<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
			</head>
			<body bgcolor="white" text="black" link="blue" vlink="#204080"
			alink="#204080">

			<!-- =========== START OF NAVBAR =========== -->
			<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
			<tr valign="center">
			<th class="navbar">   <a class="navbar" href="Pyblio-module.html">Home</a>   </th>
			<th class="navbar">   <a class="navbar" href="trees.html">Trees</a>   </th>
			<th class="navbar">   <a class="navbar" href="indices.html">Index</a>   </th>
			<th class="navbar">   <a class="navbar" href="help.html">Help</a>   </th>
			<th class="navbar" align="right" width="100%">
			<table border="0" cellpadding="0" cellspacing="0">
			<tr><th class="navbar" align="center">
			<p class="nomargin">
			pybliographer 1.3.3
			</p></th></tr></table>
			</th>
			</tr>
			</table>
			<table width="100%" cellpadding="0" cellspacing="0">
			<tr valign="top">
			<td width="100%">
			<font size="-1"><b class="breadcrumbs">
			Package twisted ::
			Package protocols ::
			Module basic ::
			Class LineReceiver
			</b></font></br>
			</td>
			<td><table cellpadding="0" cellspacing="0">
			<tr><td align="right"><font size="-2">[show private \| <a href="../public/twisted.protocols.basic.LineReceiver-class.html">hide private</a>]</font></td></tr>
			<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> \| <a href="twisted.protocols.basic.LineReceiver-class.html" target="_top">no frames</a>]</font></td></tr>
			</table></td>
			</tr></table>

			<!-- =========== START OF CLASS DESCRIPTION =========== -->
			<h2 class="class">Class LineReceiver</h2>

			<pre class="base-tree">
			<a href="../private/twisted.internet.protocol.BaseProtocol-class.html"><code>BaseProtocol</code></a> --+
			\|
			<a href="twisted.internet.protocol.Protocol-class.html"><code>Protocol</code></a> --+
			\|
			<a href="../private/twisted.protocols.basic._PauseableMixin-class.html"><code>_PauseableMixin</code></a> --+
			\|
			<b>LineReceiver</b>
			</pre><br />

			<dl><dt><b>Known Subclasses:</b></dt>
			<dd>
			<a href="twisted.web.http.HTTPClient-class.html"><code>HTTPClient</code></a></dd></dl>

			<hr/>

			<p>A protocol that receives lines and/or raw data, depending on mode.</p>
			<p>In line mode, each line that's received becomes a callback to <a
			href="twisted.protocols.basic.LineReceiver-class.html#lineReceived"
			class="link"><code>lineReceived</code></a>. In raw data mode, each chunk
			of raw data becomes a callback to <a
			href="twisted.protocols.basic.LineReceiver-class.html#rawDataReceived"
			class="link"><code>rawDataReceived</code></a>. The <a
			href="twisted.protocols.basic.LineReceiver-class.html#setLineMode"
			class="link"><code>setLineMode</code></a> and <a
			href="twisted.protocols.basic.LineReceiver-class.html#setRawMode"
			class="link"><code>setRawMode</code></a> methods switch between the two
			modes.</p>
			This is useful for line-oriented protocols such as IRC, HTTP, POP,
			etc.
			<hr/>


			<!-- =========== START OF METHOD SUMMARY =========== -->
			<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
			<tr bgcolor="#70b0f0" class="summary">
			<th colspan="2">Method Summary</th></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><span class="summary-sig"><a href="twisted.protocols.basic.LineReceiver-class.html#clearLineBuffer" class="summary-sig-name"><code>clearLineBuffer</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
			<br />
			Clear buffered data.</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><span class="summary-sig"><a href="twisted.protocols.basic.LineReceiver-class.html#dataReceived" class="summary-sig-name"><code>dataReceived</code></a>(<span class=summary-sig-arg>self</span>,
			<span class=summary-sig-arg>data</span>)</span></code>
			<br />
			Protocol.dataReceived.</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><span class="summary-sig"><a href="twisted.protocols.basic.LineReceiver-class.html#lineLengthExceeded" class="summary-sig-name"><code>lineLengthExceeded</code></a>(<span class=summary-sig-arg>self</span>,
			<span class=summary-sig-arg>line</span>)</span></code>
			<br />
			Called when the maximum line length has been reached.</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><span class="summary-sig"><a href="twisted.protocols.basic.LineReceiver-class.html#lineReceived" class="summary-sig-name"><code>lineReceived</code></a>(<span class=summary-sig-arg>self</span>,
			<span class=summary-sig-arg>line</span>)</span></code>
			<br />
			Override this for when each line is received.</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><span class="summary-sig"><a href="twisted.protocols.basic.LineReceiver-class.html#rawDataReceived" class="summary-sig-name"><code>rawDataReceived</code></a>(<span class=summary-sig-arg>self</span>,
			<span class=summary-sig-arg>data</span>)</span></code>
			<br />
			Override this for when raw data is received.</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><span class="summary-sig"><a href="twisted.protocols.basic.LineReceiver-class.html#sendLine" class="summary-sig-name"><code>sendLine</code></a>(<span class=summary-sig-arg>self</span>,
			<span class=summary-sig-arg>line</span>)</span></code>
			<br />
			Sends a line to the other end of the connection.</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><span class="summary-sig"><a href="twisted.protocols.basic.LineReceiver-class.html#setLineMode" class="summary-sig-name"><code>setLineMode</code></a>(<span class=summary-sig-arg>self</span>,
			<span class=summary-sig-arg>extra</span>)</span></code>
			<br />
			Sets the line-mode of this receiver.</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><span class="summary-sig"><a href="twisted.protocols.basic.LineReceiver-class.html#setRawMode" class="summary-sig-name"><code>setRawMode</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
			<br />
			Sets the raw mode of this receiver.</td></tr>
			<tr bgcolor="#e8f0f8" class="group">
			<th colspan="2">    Inherited from Protocol</th></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><span class="summary-sig"><a href="twisted.internet.protocol.Protocol-class.html#connectionLost" class="summary-sig-name"><code>connectionLost</code></a>(<span class=summary-sig-arg>self</span>,
			<span class=summary-sig-arg>reason</span>)</span></code>
			<br />
			Called when the connection is shut down.</td></tr>
			<tr bgcolor="#e8f0f8" class="group">
			<th colspan="2">    Inherited from BaseProtocol</th></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><span class="summary-sig"><a href="../private/twisted.internet.protocol.BaseProtocol-class.html#connectionMade" class="summary-sig-name"><code>connectionMade</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
			<br />
			Called when a connection is made.</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><span class="summary-sig"><a href="../private/twisted.internet.protocol.BaseProtocol-class.html#makeConnection" class="summary-sig-name"><code>makeConnection</code></a>(<span class=summary-sig-arg>self</span>,
			<span class=summary-sig-arg>transport</span>)</span></code>
			<br />
			Make a connection to a transport and a server.</td></tr>
			<tr bgcolor="#e8f0f8" class="group">
			<th colspan="2">    Inherited from _PauseableMixin</th></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><span class="summary-sig"><a href="../private/twisted.protocols.basic._PauseableMixin-class.html#pauseProducing" class="summary-sig-name"><code>pauseProducing</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
			</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><span class="summary-sig"><a href="../private/twisted.protocols.basic._PauseableMixin-class.html#resumeProducing" class="summary-sig-name"><code>resumeProducing</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
			</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
			<td><code><span class="summary-sig"><a href="../private/twisted.protocols.basic._PauseableMixin-class.html#stopProducing" class="summary-sig-name"><code>stopProducing</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
			</td></tr>
			</table><br />


			<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
			<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
			<tr bgcolor="#70b0f0" class="summary">
			<th colspan="2">Class Variable Summary</th></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
			<td><b><a href="twisted.protocols.basic.LineReceiver-class.html#delimiter"><code>delimiter</code></a></b>: The line-ending delimiter to use.</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
			<td><b><a href="twisted.protocols.basic.LineReceiver-class.html#line_mode"><code>line_mode</code></a></b> = <span title="1">1                                                                     </span></td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
			<td><b><a href="twisted.protocols.basic.LineReceiver-class.html#MAX_LENGTH"><code>MAX_LENGTH</code></a></b>: The maximum length of a line to allow (If a sent line is longer than
			this, the connection is dropped).</td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
			<td><b><a href="../private/twisted.protocols.basic.LineReceiver-class.html#__buffer"><code>_LineReceiver__buffer</code></a></b> = <span title="''"><code><span class="variable-quote">'</span><span class="variable-quote">'</span> </code>
			</span></td></tr>
			<tr bgcolor="#e8f0f8" class="group">
			<th colspan="2">    Inherited from Protocol</th></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"><code>Implements</code></font></td>
			<td><b><a href="twisted.internet.protocol.Protocol-class.html#__implemented__"><code>__implemented__</code></a></b> = <span title="<implementedBy twisted.internet.protocol.Protocol>"><code><implementedBy twisted.internet.protoc<span class="variable-ellipsis">...</span></code>
			</span></td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"><code>ClassProvides</code></font></td>
			<td><b><a href="twisted.internet.protocol.Protocol-class.html#__provides__"><code>__provides__</code></a></b> = <span title="<zope.interface.declarations.ClassProvides object at 0xa57f256c>"><code><zope.interface.declarations.ClassProvide<span class="variable-ellipsis">...</span></code>
			</span></td></tr>
			<tr bgcolor="#e8f0f8" class="group">
			<th colspan="2">    Inherited from BaseProtocol</th></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"><code>ClassProvides</code></font></td>
			<td><b><a href="../private/twisted.internet.protocol.BaseProtocol-class.html#__providedBy__"><code>__providedBy__</code></a></b> = <span title="<zope.interface.declarations.ClassProvides object at 0xa57f23cc>"><code><zope.interface.declarations.ClassProvi<span class="variable-ellipsis">...</span></code>
			</span></td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
			<td><b><a href="../private/twisted.internet.protocol.BaseProtocol-class.html#connected"><code>connected</code></a></b> = <span title="0">0                                                                     </span></td></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
			<td><b><a href="../private/twisted.internet.protocol.BaseProtocol-class.html#transport"><code>transport</code></a></b> = <span title="None">None                                                                  </span></td></tr>
			<tr bgcolor="#e8f0f8" class="group">
			<th colspan="2">    Inherited from _PauseableMixin</th></tr>
			<tr><td align="right" valign="top" width="15%"><font size="-1"><code>bool</code></font></td>
			<td><b><a href="../private/twisted.protocols.basic._PauseableMixin-class.html#paused"><code>paused</code></a></b> = <span title="False"><code>False </code>
			</span></td></tr>
			</table><br />


			<!-- =========== START OF METHOD DETAILS =========== -->
			<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
			<tr bgcolor="#70b0f0" class="details">
			<th colspan="2">Method Details</th></tr>
			</table>

			<a name="clearLineBuffer"></a>
			<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
			<h3><span class="sig"><span class="sig-name">clearLineBuffer</span>(<span class=sig-arg>self</span>)</span>
			</h3>
			Clear buffered data.
			<dl><dt></dt><dd>
			</dd></dl>
			</td></tr></table>

			<a name="dataReceived"></a>
			<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
			<h3><span class="sig"><span class="sig-name">dataReceived</span>(<span class=sig-arg>self</span>,
			<span class=sig-arg>data</span>)</span>
			</h3>
			Protocol.dataReceived. Translates bytes into lines, and calls
			lineReceived (or rawDataReceived, depending on mode.)
			<dl><dt></dt><dd>
			<dl><dt><b>Overrides:</b></dt>
			<dd><a href="twisted.internet.protocol.Protocol-class.html#dataReceived"><code>twisted.internet.protocol.Protocol.dataReceived</code></a></dd>
			</dl>
			</dd></dl>
			</td></tr></table>

			<a name="lineLengthExceeded"></a>
			<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
			<h3><span class="sig"><span class="sig-name">lineLengthExceeded</span>(<span class=sig-arg>self</span>,
			<span class=sig-arg>line</span>)</span>
			</h3>
			<p>Called when the maximum line length has been reached. Override if it
			needs to be dealt with in some special way.</p>
			The argument 'line' contains the remainder of the buffer, starting
			with (at least some part) of the line which is too long. This may be
			more than one line, or may be only the initial portion of the line.
			<dl><dt></dt><dd>
			</dd></dl>
			</td></tr></table>

			<a name="lineReceived"></a>
			<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
			<h3><span class="sig"><span class="sig-name">lineReceived</span>(<span class=sig-arg>self</span>,
			<span class=sig-arg>line</span>)</span>
			</h3>
			Override this for when each line is received.
			<dl><dt></dt><dd>
			</dd></dl>
			</td></tr></table>

			<a name="rawDataReceived"></a>
			<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
			<h3><span class="sig"><span class="sig-name">rawDataReceived</span>(<span class=sig-arg>self</span>,
			<span class=sig-arg>data</span>)</span>
			</h3>
			Override this for when raw data is received.
			<dl><dt></dt><dd>
			</dd></dl>
			</td></tr></table>

			<a name="sendLine"></a>
			<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
			<h3><span class="sig"><span class="sig-name">sendLine</span>(<span class=sig-arg>self</span>,
			<span class=sig-arg>line</span>)</span>
			</h3>
			Sends a line to the other end of the connection.
			<dl><dt></dt><dd>
			</dd></dl>
			</td></tr></table>

			<a name="setLineMode"></a>
			<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
			<h3><span class="sig"><span class="sig-name">setLineMode</span>(<span class=sig-arg>self</span>,
			<span class=sig-arg>extra</span>=<span class=sig-default>''</span>)</span>
			</h3>
			<p>Sets the line-mode of this receiver.</p>
			<p>If you are calling this from a rawDataReceived callback, you can
			pass in extra unhandled data, and that data will be parsed for lines.
			Further data received will be sent to lineReceived rather than
			rawDataReceived.</p>
			Do not pass extra data if calling this function from within a
			lineReceived callback.
			<dl><dt></dt><dd>
			</dd></dl>
			</td></tr></table>

			<a name="setRawMode"></a>
			<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
			<h3><span class="sig"><span class="sig-name">setRawMode</span>(<span class=sig-arg>self</span>)</span>
			</h3>
			Sets the raw mode of this receiver. Further data received will be
			sent to rawDataReceived rather than lineReceived.
			<dl><dt></dt><dd>
			</dd></dl>
			</td></tr></table>
			<br />


			<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
			<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
			<tr bgcolor="#70b0f0" class="details">
			<th colspan="2">Class Variable Details</th></tr>
			</table>
			<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
			<a name="delimiter"></a>
			<h3>delimiter</h3>
			The line-ending delimiter to use. By default this is '\r\n'.
			<dl>
			<dt></dt>
			<dd>
			<dl>
			<dt><b>Type:</b></dt>
			<dd>
			<code>str</code>

			</dd>
			<span title="'\r\n'"> <dt><b>Value:</b></dt>
			<dd><table><tr><td>
			<pre class="variable">
			<span class="variable-quote">'''</span>\r
			<span class="variable-quote">'''</span> </pre>
			</td></tr></table></dd>
			</span> </dl>
			</dd>
			</dl></td></tr></table>
			<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
			<a name="line_mode"></a>
			<h3>line_mode</h3>
			<dl>
			<dt></dt>
			<dd>
			<dl>
			<dt><b>Type:</b></dt>
			<dd>
			<code>int</code>

			</dd>
			<span title="1"> <dt><b>Value:</b></dt>
			<dd><table><tr><td>
			<pre class="variable">
			1                                                                     </pre>
			</td></tr></table></dd>
			</span> </dl>
			</dd>
			</dl></td></tr></table>
			<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
			<a name="MAX_LENGTH"></a>
			<h3>MAX_LENGTH</h3>
			The maximum length of a line to allow (If a sent line is longer than
			this, the connection is dropped). Default is 16384.
			<dl>
			<dt></dt>
			<dd>
			<dl>
			<dt><b>Type:</b></dt>
			<dd>
			<code>int</code>

			</dd>
			<span title="16384"> <dt><b>Value:</b></dt>
			<dd><table><tr><td>
			<pre class="variable">
			16384                                                                 </pre>
			</td></tr></table></dd>
			</span> </dl>
			</dd>
			</dl></td></tr></table>
			<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
			<a name="_LineReceiver__buffer"></a>
			<h3>_LineReceiver__buffer</h3>
			<dl>
			<dt></dt>
			<dd>
			<dl>
			<dt><b>Type:</b></dt>
			<dd>
			<code>str</code>

			</dd>
			<span title="''"> <dt><b>Value:</b></dt>
			<dd><table><tr><td>
			<pre class="variable">
			<span class="variable-quote">'</span><span class="variable-quote">'</span> </pre>
			</td></tr></table></dd>
			</span> </dl>
			</dd>
			</dl></td></tr></table>
			<br />


			<!-- =========== START OF NAVBAR =========== -->
			<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
			<tr valign="center">
			<th class="navbar">   <a class="navbar" href="Pyblio-module.html">Home</a>   </th>
			<th class="navbar">   <a class="navbar" href="trees.html">Trees</a>   </th>
			<th class="navbar">   <a class="navbar" href="indices.html">Index</a>   </th>
			<th class="navbar">   <a class="navbar" href="help.html">Help</a>   </th>
			<th class="navbar" align="right" width="100%">
			<table border="0" cellpadding="0" cellspacing="0">
			<tr><th class="navbar" align="center">
			<p class="nomargin">
			pybliographer 1.3.3
			</p></th></tr></table>
			</th>
			</tr>
			</table>

			<table border="0" cellpadding="0" cellspacing="0" width="100%">
			<tr>
			<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Sep 24 23:52:43 2006</font></td>
			<td align="right"><a href="http://epydoc.sourceforge.net"
			><font size="-2">http://epydoc.sf.net</font></a></td>
			</tr>
			</table>
			</body>
			</html>

R3596/doc/reference/private/twisted.protocols.basic.LineReceiver-class.htmlfb50ed06a412master

twisted.protocols.basic.LineReceiver-class.htmlView Options

R3596/doc/reference/private/twisted.protocols.basic.LineReceiver-class.html
fb50ed06a412master

twisted.protocols.basic.LineReceiver-class.html
View Options