twisted.internet.protocol.BaseProtocol-class.html
fb50ed06a412master

twisted.internet.protocol.BaseProtocol-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.internet.protocol.BaseProtocol</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 internet ::
			Module protocol ::
			Class BaseProtocol
			</b></font></br>
			</td>
			<td><table cellpadding="0" cellspacing="0">
			<tr><td align="right"><font size="-2">[<b>show private</b> \| hide private]</font></td></tr>
			<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> \| <a href="../private/twisted.internet.protocol.BaseProtocol-class.html" target="_top">no frames</a>]</font></td></tr>
			</table></td>
			</tr></table>

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

			<dl><dt><b>Known Subclasses:</b></dt>
			<dd>
			<a href="twisted.internet.protocol.Protocol-class.html"><code>Protocol</code></a></dd></dl>

			<hr/>

			<p>This is the abstract superclass of all protocols.</p>
			<p>If you are going to write a new protocol for Twisted, start here. The
			docstrings of this class explain how you can get started. Any protocol
			implementation, either client or server, should be a subclass of me.</p>
			<p>My API is quite simple. Implement dataReceived(data) to handle both
			event-based and synchronous input; output can be sent through the
			'transport' attribute, which is to be an instance that implements
			<code>twisted.internet.interfaces.ITransport</code>.</p>
			Some subclasses exist already to help you write common types of
			protocols: see the <code>twisted.protocols.basic</code> module for a few
			of them.
			<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="../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>
			</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>Implements</code></font></td>
			<td><b><a href="../private/twisted.internet.protocol.BaseProtocol-class.html#__implemented__"><code>__implemented__</code></a></b> = <span title="<implementedBy twisted.internet.protocol.BaseProtocol>"><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="../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>ClassProvides</code></font></td>
			<td><b><a href="../private/twisted.internet.protocol.BaseProtocol-class.html#__provides__"><code>__provides__</code></a></b> = <span title="<zope.interface.declarations.ClassProvides object at 0xa57f23cc>"><code><zope.interface.declarations.ClassProvide<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>
			</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="connectionMade"></a>
			<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
			<h3><span class="sig"><span class="sig-name">connectionMade</span>(<span class=sig-arg>self</span>)</span>
			</h3>
			<p>Called when a connection is made.</p>
			This may be considered the initializer of the protocol, because it
			is called when the connection is completed. For clients, this is called
			once the connection to the server has been established; for servers,
			this is called after an accept() call stops blocking and a socket has
			been received. If you need to send any greeting or initial message, do
			it here.
			<dl><dt></dt><dd>
			</dd></dl>
			</td></tr></table>

			<a name="makeConnection"></a>
			<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
			<h3><span class="sig"><span class="sig-name">makeConnection</span>(<span class=sig-arg>self</span>,
			<span class=sig-arg>transport</span>)</span>
			</h3>
			<p>Make a connection to a transport and a server.</p>
			This sets the 'transport' attribute of this Protocol, and calls the
			connectionMade() callback.
			<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="__implemented__"></a>
			<h3>__implemented__</h3>
			<dl>
			<dt></dt>
			<dd>
			<dl>
			<dt><b>Type:</b></dt>
			<dd>
			<code>Implements</code>

			</dd>
			<span title="<implementedBy twisted.internet.protocol.BaseProtocol>"> <dt><b>Value:</b></dt>
			<dd><table><tr><td>
			<pre class="variable">
			<implementedBy twisted.internet.protocol.BaseProtocol> </pre>
			</td></tr></table></dd>
			</span> </dl>
			</dd>
			</dl></td></tr></table>
			<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
			<a name="__providedBy__"></a>
			<h3>__providedBy__</h3>
			<dl>
			<dt></dt>
			<dd>
			<dl>
			<dt><b>Type:</b></dt>
			<dd>
			<code>ClassProvides</code>

			</dd>
			<span title="<zope.interface.declarations.ClassProvides object at 0xa57f23cc>"> <dt><b>Value:</b></dt>
			<dd><table><tr><td>
			<pre class="variable">
			<zope.interface.declarations.ClassProvides object at 0xa57f23cc> </pre>
			</td></tr></table></dd>
			</span> </dl>
			</dd>
			</dl></td></tr></table>
			<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
			<a name="__provides__"></a>
			<h3>__provides__</h3>
			<dl>
			<dt></dt>
			<dd>
			<dl>
			<dt><b>Type:</b></dt>
			<dd>
			<code>ClassProvides</code>

			</dd>
			<span title="<zope.interface.declarations.ClassProvides object at 0xa57f23cc>"> <dt><b>Value:</b></dt>
			<dd><table><tr><td>
			<pre class="variable">
			<zope.interface.declarations.ClassProvides object at 0xa57f23cc> </pre>
			</td></tr></table></dd>
			</span> </dl>
			</dd>
			</dl></td></tr></table>
			<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
			<a name="connected"></a>
			<h3>connected</h3>
			<dl>
			<dt></dt>
			<dd>
			<dl>
			<dt><b>Type:</b></dt>
			<dd>
			<code>int</code>

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

			</dd>
			<span title="None"> <dt><b>Value:</b></dt>
			<dd><table><tr><td>
			<pre class="variable">
			None                                                                  </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.internet.protocol.BaseProtocol-class.htmlfb50ed06a412master

twisted.internet.protocol.BaseProtocol-class.htmlView Options

R3596/doc/reference/private/twisted.internet.protocol.BaseProtocol-class.html
fb50ed06a412master

twisted.internet.protocol.BaseProtocol-class.html
View Options