twisted.application.strports.html [plain text]
<?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.application.strports</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="twisted.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">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</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">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.application.html">Package application</a> ::
Module strports
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.application.strports.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.application.strports</h2>
<p>Port description language</p>
<p>This module implements a description mini-language for ports, and
provides functions to parse it and to use it to directly construct
appropriate network server services or to directly listen on them.</p>
Here are some examples:
<pre class="literalblock">
>>> s=service("80", server.Site())
>>> s=service("tcp:80", server.Site())
>>> s=service("tcp:80:interface=127.0.0.1", server.Site())
>>> s=service("ssl:443", server.Site())
>>> s=service("ssl:443:privateKey=mykey.pem", server.Site())
>>> s=service("ssl:443:privateKey=mykey.pem:certKey=cert.pem", server.Site())
>>> s=service("unix:/var/run/finger", FingerFactory())
>>> s=service("unix:/var/run/finger:mode=660", FingerFactory())
>>> p=listen("80", server.Site())
>>> p=listen("tcp:80", server.Site())
>>> p=listen("tcp:80:interface=127.0.0.1", server.Site())
>>> p=listen("ssl:443", server.Site())
>>> p=listen("ssl:443:privateKey=mykey.pem", server.Site())
>>> p=listen("ssl:443:privateKey=mykey.pem:certKey=cert.pem", server.Site())
>>> p=listen("unix:/var/run/finger", FingerFactory())
>>> p=listen("unix:/var/run/finger:mode=660", FingerFactory())
</pre>
<p>See specific function documentation for more information.</p>
<p>API Stability: unstable</p>
Maintainer: <a href="mailto:moshez@twistedmatrix.com">Moshe
Zadka</a>
<hr/>
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_parse"></a><span class="summary-sig"><span class="summary-sig-name">_parse</span>(<span class=summary-sig-arg>description</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_parseSSL"></a><span class="summary-sig"><span class="summary-sig-name">_parseSSL</span>(<span class=summary-sig-arg>factory</span>,
<span class=summary-sig-arg>port</span>,
<span class=summary-sig-arg>privateKey</span>,
<span class=summary-sig-arg>certKey</span>,
<span class=summary-sig-arg>sslmethod</span>,
<span class=summary-sig-arg>interface</span>,
<span class=summary-sig-arg>backlog</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_parseTCP"></a><span class="summary-sig"><span class="summary-sig-name">_parseTCP</span>(<span class=summary-sig-arg>factory</span>,
<span class=summary-sig-arg>port</span>,
<span class=summary-sig-arg>interface</span>,
<span class=summary-sig-arg>backlog</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_parseUNIX"></a><span class="summary-sig"><span class="summary-sig-name">_parseUNIX</span>(<span class=summary-sig-arg>factory</span>,
<span class=summary-sig-arg>address</span>,
<span class=summary-sig-arg>mode</span>,
<span class=summary-sig-arg>backlog</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_tokenize"></a><span class="summary-sig"><span class="summary-sig-name">_tokenize</span>(<span class=summary-sig-arg>description</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>twisted.internet.interfaces.IListeningPort</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.application.strports.html#listen" class="summary-sig-name"><code>listen</code></a>(<span class=summary-sig-arg>description</span>,
<span class=summary-sig-arg>factory</span>,
<span class=summary-sig-arg>default</span>)</span></code>
<br />
Listen on a port corresponding to a description</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>tuple</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.application.strports.html#parse" class="summary-sig-name"><code>parse</code></a>(<span class=summary-sig-arg>description</span>,
<span class=summary-sig-arg>factory</span>,
<span class=summary-sig-arg>default</span>)</span></code>
<br />
Parse a description of a reliable virtual circuit server</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>twisted.application.service.IService</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.application.strports.html#service" class="summary-sig-name"><code>service</code></a>(<span class=summary-sig-arg>description</span>,
<span class=summary-sig-arg>factory</span>,
<span class=summary-sig-arg>default</span>)</span></code>
<br />
Return the service corresponding to a description</td></tr>
</table><br />
<!-- =========== START OF VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
<td><b><a href="twisted.application.strports.html#_funcs"><code>_funcs</code></a></b> = <span title="{'ssl': <function _parseSSL at 0x871edc4>, 'unix': <function _parseUNIX at 0x86a89e4>, 'tcp': <function _parseTCP at 0x853ad64>}"><code>{'ssl': <function _parseSSL at 0x871edc4>, 'uni<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="twisted.application.strports.html#_OP"><code>_OP</code></a></b> = <span title="0">0 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.application.strports.html#_STRING"><code>_STRING</code></a></b> = <span title="1">1 </span></td></tr>
</table><br />
<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Function Details</th></tr>
</table>
<a name="listen"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">listen</span>(<span class=sig-arg>description</span>,
<span class=sig-arg>factory</span>,
<span class=sig-arg>default</span>=<span class=sig-default>None</span>)</span>
</h3>
Listen on a port corresponding to a description
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>description</b></code>
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>factory</b></code>
<br /><i>
(type=<p><code>twisted.internet.interfaces.IProtocolFactory</code>)</i>
<dd><code><b>default</b></code>
<br /><i>
(type=<code>str</code> or <code>None</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>the port corresponding to a description of a reliable virtual
circuit server.</p>
See the documentation of the <code>parse</code> function for
description of the semantics of the arguments.
<br /><i>
(type=<code>twisted.internet.interfaces.IListeningPort</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="parse"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parse</span>(<span class=sig-arg>description</span>,
<span class=sig-arg>factory</span>,
<span class=sig-arg>default</span>=<span class=sig-default>None</span>)</span>
</h3>
Parse a description of a reliable virtual circuit server
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>description</b></code>
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>factory</b></code>
<br /><i>
(type=<p><code>twisted.internet.interfaces.IProtocolFactory</code>)</i>
<dd><code><b>default</b></code>
<br /><i>
(type=<code>str</code> or <code>None</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
a tuple of string, tuple and dictionary. The string is the
name of the method (sans <code>'listen'</code>) to call, and the
tuple and dictionary are the arguments and keyword arguments to
the method.
<br /><i>
(type=<code>tuple</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="service"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">service</span>(<span class=sig-arg>description</span>,
<span class=sig-arg>factory</span>,
<span class=sig-arg>default</span>=<span class=sig-default>None</span>)</span>
</h3>
Return the service corresponding to a description
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>description</b></code>
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>factory</b></code>
<br /><i>
(type=<p><code>twisted.internet.interfaces.IProtocolFactory</code>)</i>
<dd><code><b>default</b></code>
<br /><i>
(type=<code>str</code> or <code>None</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>the service corresponding to a description of a reliable
virtual circuit server.</p>
See the documentation of the <code>parse</code> function for
description of the semantics of the arguments.
<br /><i>
(type=<code>twisted.application.service.IService</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_funcs"></a>
<h3>_funcs</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>dict</code>
</dd>
<span title="{'ssl': <function _parseSSL at 0x871edc4>, 'unix': <function _parseUNIX at 0x86a89e4>, 'tcp': <function _parseTCP at 0x853ad64>}"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
{'ssl': <function _parseSSL at 0x871edc4>,
'tcp': <function _parseTCP at 0x853ad64>,
'unix': <function _parseUNIX at 0x86a89e4>} </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_OP"></a>
<h3>_OP</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="_STRING"></a>
<h3>_STRING</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>
<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="twisted.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">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</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.0 on Sat May 15 20:08:44 2004</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>