twisted.internet.app.Application.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.internet.app.Application</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.internet.html">Package internet</a> ::
<a href="twisted.internet.app.html">Module app</a> ::
Class Application
</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.internet.app.Application.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class Application</h2>
<pre class="base-tree">
<a href="twisted.internet.app._AbstractServiceCollection.html"><code>_AbstractServiceCollection</code></a> --+
|
<a href="twisted.python.reflect.Accessor.html"><code>Accessor</code></a> --+
|
<a href="twisted.python.log.Logger.html"><code>Logger</code></a> --+
|
<a href="twisted.persisted.styles.Versioned.html"><code>Versioned</code></a> --+
|
<b>Application</b>
</pre><br />
<hr/>
<p>I am the `root object' in a Twisted process.</p>
I represent a set of persistent, potentially interconnected listening
TCP ports, delayed event schedulers, and service.Services.
<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.internet.app.Application.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>,
<span class=summary-sig-arg>uid</span>,
<span class=summary-sig-arg>gid</span>,
<span class=summary-sig-arg>authorizer</span>,
<span class=summary-sig-arg>authorizer_</span>)</span></code>
<br />
Initialize me.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__getstate__"></a><span class="summary-sig"><span class="summary-sig-name">__getstate__</span>(<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><a name="__repr__"></a><span class="summary-sig"><span class="summary-sig-name">__repr__</span>(<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><a name="_afterShutDown"></a><span class="summary-sig"><span class="summary-sig-name">_afterShutDown</span>(<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><a name="_beforeShutDown"></a><span class="summary-sig"><span class="summary-sig-name">_beforeShutDown</span>(<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><a name="_doBindPorts"></a><span class="summary-sig"><span class="summary-sig-name">_doBindPorts</span>(<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><a name="bindPorts"></a><span class="summary-sig"><span class="summary-sig-name">bindPorts</span>(<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="twisted.internet.app.Application.html#connectSSL" class="summary-sig-name"><code>connectSSL</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>host</span>,
<span class=summary-sig-arg>port</span>,
<span class=summary-sig-arg>factory</span>,
<span class=summary-sig-arg>ctxFactory</span>,
<span class=summary-sig-arg>timeout</span>,
<span class=summary-sig-arg>bindAddress</span>)</span></code>
<br />
Connect a given client protocol factory to a specific SSL server.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#connectTCP" class="summary-sig-name"><code>connectTCP</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>host</span>,
<span class=summary-sig-arg>port</span>,
<span class=summary-sig-arg>factory</span>,
<span class=summary-sig-arg>timeout</span>,
<span class=summary-sig-arg>bindAddress</span>)</span></code>
<br />
Connect a given client protocol factory to a specific TCP server.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#connectUDP" class="summary-sig-name"><code>connectUDP</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>remotehost</span>,
<span class=summary-sig-arg>remoteport</span>,
<span class=summary-sig-arg>protocol</span>,
<span class=summary-sig-arg>localport</span>,
<span class=summary-sig-arg>interface</span>,
<span class=summary-sig-arg>maxPacketSize</span>)</span></code>
<br />
Connects a <code>ConnectedDatagramProtocol</code> instance to a UDP
port.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#connectUNIX" class="summary-sig-name"><code>connectUNIX</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>address</span>,
<span class=summary-sig-arg>factory</span>,
<span class=summary-sig-arg>timeout</span>)</span></code>
<br />
Connect a given client protocol factory to a specific UNIX socket.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#connectWith" class="summary-sig-name"><code>connectWith</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>connectorType</span>,
<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
<br />
Start an instance of the given <code>connectorType</code>
connecting.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="get_authorizer"></a><span class="summary-sig"><span class="summary-sig-name">get_authorizer</span>(<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="twisted.internet.app.Application.html#listenSSL" class="summary-sig-name"><code>listenSSL</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>port</span>,
<span class=summary-sig-arg>factory</span>,
<span class=summary-sig-arg>ctxFactory</span>,
<span class=summary-sig-arg>backlog</span>,
<span class=summary-sig-arg>interface</span>)</span></code>
<br />
Connects a given protocol factory to the given numeric TCP/IP
port.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#listenTCP" class="summary-sig-name"><code>listenTCP</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>port</span>,
<span class=summary-sig-arg>factory</span>,
<span class=summary-sig-arg>backlog</span>,
<span class=summary-sig-arg>interface</span>)</span></code>
<br />
Connects a given protocol factory to the given numeric TCP/IP
port.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#listenUDP" class="summary-sig-name"><code>listenUDP</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>port</span>,
<span class=summary-sig-arg>proto</span>,
<span class=summary-sig-arg>interface</span>,
<span class=summary-sig-arg>maxPacketSize</span>)</span></code>
<br />
Connects a given DatagramProtocol to the given numeric UDP port.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#listenUNIX" class="summary-sig-name"><code>listenUNIX</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>filename</span>,
<span class=summary-sig-arg>factory</span>,
<span class=summary-sig-arg>backlog</span>,
<span class=summary-sig-arg>mode</span>)</span></code>
<br />
Connects a given protocol factory to the UNIX socket with the given
filename.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#listenWith" class="summary-sig-name"><code>listenWith</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>portType</span>,
<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
<br />
Start an instance of the given <code>portType</code> listening.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#logPrefix" class="summary-sig-name"><code>logPrefix</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
A log prefix which describes me.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#run" class="summary-sig-name"><code>run</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>save</span>,
<span class=summary-sig-arg>installSignalHandlers</span>)</span></code>
<br />
run(save=1, installSignalHandlers=1) Run this application, running the
main loop if necessary.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#save" class="summary-sig-name"><code>save</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>tag</span>,
<span class=summary-sig-arg>filename</span>,
<span class=summary-sig-arg>passphrase</span>)</span></code>
<br />
Save a pickle of this application to a file in the current
directory.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#setEUID" class="summary-sig-name"><code>setEUID</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Retrieve persistent uid/gid pair (if possible) and set the current
process's euid/egid.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#setUID" class="summary-sig-name"><code>setUID</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Retrieve persistent uid/gid pair (if possible) and set the current
process's uid/gid</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#unlistenSSL" class="summary-sig-name"><code>unlistenSSL</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>port</span>,
<span class=summary-sig-arg>interface</span>)</span></code>
<br />
Stop an SSL Port listening on the given interface and port.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#unlistenTCP" class="summary-sig-name"><code>unlistenTCP</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>port</span>,
<span class=summary-sig-arg>interface</span>)</span></code>
<br />
Stop a Port listening on the given port and interface.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#unlistenUDP" class="summary-sig-name"><code>unlistenUDP</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>port</span>,
<span class=summary-sig-arg>interface</span>)</span></code>
<br />
Stop a DatagramProtocol listening on the given local port and
interface.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#unlistenUNIX" class="summary-sig-name"><code>unlistenUNIX</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>filename</span>)</span></code>
<br />
Stop a Port listening on the given filename.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#unlistenWith" class="summary-sig-name"><code>unlistenWith</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>portType</span>,
<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
<br />
Stop a Port listening with the given parameters.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#upgradeToVersion1" class="summary-sig-name"><code>upgradeToVersion1</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Version 1 Persistence Upgrade</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="upgradeToVersion10"></a><span class="summary-sig"><span class="summary-sig-name">upgradeToVersion10</span>(<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><a name="upgradeToVersion11"></a><span class="summary-sig"><span class="summary-sig-name">upgradeToVersion11</span>(<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><a name="upgradeToVersion12"></a><span class="summary-sig"><span class="summary-sig-name">upgradeToVersion12</span>(<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="twisted.internet.app.Application.html#upgradeToVersion2" class="summary-sig-name"><code>upgradeToVersion2</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Version 2 Persistence Upgrade</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#upgradeToVersion3" class="summary-sig-name"><code>upgradeToVersion3</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Version 3 Persistence Upgrade</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.Application.html#upgradeToVersion4" class="summary-sig-name"><code>upgradeToVersion4</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Version 4 Persistence Upgrade</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="upgradeToVersion5"></a><span class="summary-sig"><span class="summary-sig-name">upgradeToVersion5</span>(<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><a name="upgradeToVersion6"></a><span class="summary-sig"><span class="summary-sig-name">upgradeToVersion6</span>(<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><a name="upgradeToVersion7"></a><span class="summary-sig"><span class="summary-sig-name">upgradeToVersion7</span>(<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><a name="upgradeToVersion8"></a><span class="summary-sig"><span class="summary-sig-name">upgradeToVersion8</span>(<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><a name="upgradeToVersion9"></a><span class="summary-sig"><span class="summary-sig-name">upgradeToVersion9</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Versioned</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.persisted.styles.Versioned.html#__setstate__" class="summary-sig-name"><code>__setstate__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>state</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="twisted.persisted.styles.Versioned.html#versionUpgrade" class="summary-sig-name"><code>versionUpgrade</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
(internal) Do a version upgrade.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Accessor</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.reflect.Accessor.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>k</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="twisted.python.reflect.Accessor.html#__getattr__" class="summary-sig-name"><code>__getattr__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>k</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="twisted.python.reflect.Accessor.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>k</span>,
<span class=summary-sig-arg>v</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="twisted.python.reflect.Accessor.html#reallyDel" class="summary-sig-name"><code>reallyDel</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>k</span>)</span></code>
<br />
*actually* del self.k without incurring side-effects.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.reflect.Accessor.html#reallySet" class="summary-sig-name"><code>reallySet</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>k</span>,
<span class=summary-sig-arg>v</span>)</span></code>
<br />
*actually* set self.k to v without incurring side-effects.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from _AbstractServiceCollection</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.app._AbstractServiceCollection.html#addService" class="summary-sig-name"><code>addService</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>service</span>)</span></code>
<br />
Add a service to this collection.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app._AbstractServiceCollection.html#getServiceNamed" class="summary-sig-name"><code>getServiceNamed</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>serviceName</span>)</span></code>
<br />
Retrieve the named service from this application.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app._AbstractServiceCollection.html#removeService" class="summary-sig-name"><code>removeService</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>service</span>)</span></code>
<br />
Remove a service from this collection.</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>NoneType</code></font></td>
<td><b><a href="twisted.internet.app.Application.html#_authorizer"><code>_authorizer</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.internet.app.Application.html#_boundPorts"><code>_boundPorts</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.internet.app.Application.html#persistenceVersion"><code>persistenceVersion</code></a></b> = <span title="12">12 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.internet.app.Application.html#persistStyle"><code>persistStyle</code></a></b> = <span title="'pickle'"><code><span class="variable-quote">'</span>pickle<span class="variable-quote">'</span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.internet.app.Application.html#processName"><code>processName</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.internet.app.Application.html#running"><code>running</code></a></b> = <span title="0">0 </span></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Versioned</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="twisted.persisted.styles.Versioned.html#persistenceForgets"><code>persistenceForgets</code></a></b> = <span title="()"><code>() </code>
</span></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from _AbstractServiceCollection</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="twisted.internet.app._AbstractServiceCollection.html#__implements__"><code>__implements__</code></a></b> = <span title="(<class twisted.internet.interfaces.IServiceCollection at 0x8250004>,)"><code>(<class twisted.internet.interfaces.ISe<span class="variable-ellipsis">...</span></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="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>name</span>,
<span class=sig-arg>uid</span>=<span class=sig-default>None</span>,
<span class=sig-arg>gid</span>=<span class=sig-default>None</span>,
<span class=sig-arg>authorizer</span>=<span class=sig-default>None</span>,
<span class=sig-arg>authorizer_</span>=<span class=sig-default>None</span>)</span>
<br /><i>(Constructor)</i>
</h3>
<p>Initialize me.</p>
If uid and gid arguments are not provided, this application will
default to having the uid and gid of the user and group who created
it.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>name</b></code> -
a name
<dd><code><b>uid</b></code> -
(optional) a POSIX user-id. Only used on POSIX systems.
<dd><code><b>gid</b></code> -
(optional) a POSIX group-id. Only used on POSIX systems.
</dd>
</dl>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.internet.app._AbstractServiceCollection.html#__init__"><code>twisted.internet.app._AbstractServiceCollection.__init__</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="connectSSL"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">connectSSL</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>host</span>,
<span class=sig-arg>port</span>,
<span class=sig-arg>factory</span>,
<span class=sig-arg>ctxFactory</span>,
<span class=sig-arg>timeout</span>=<span class=sig-default>30</span>,
<span class=sig-arg>bindAddress</span>=<span class=sig-default>None</span>)</span>
</h3>
Connect a given client protocol factory to a specific SSL
server.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="connectTCP"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">connectTCP</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>host</span>,
<span class=sig-arg>port</span>,
<span class=sig-arg>factory</span>,
<span class=sig-arg>timeout</span>=<span class=sig-default>30</span>,
<span class=sig-arg>bindAddress</span>=<span class=sig-default>None</span>)</span>
</h3>
Connect a given client protocol factory to a specific TCP
server.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="connectUDP"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">connectUDP</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>remotehost</span>,
<span class=sig-arg>remoteport</span>,
<span class=sig-arg>protocol</span>,
<span class=sig-arg>localport</span>=<span class=sig-default>0</span>,
<span class=sig-arg>interface</span>=<span class=sig-default>''</span>,
<span class=sig-arg>maxPacketSize</span>=<span class=sig-default>8192</span>)</span>
</h3>
Connects a <code>ConnectedDatagramProtocol</code> instance to a UDP
port.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="connectUNIX"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">connectUNIX</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>address</span>,
<span class=sig-arg>factory</span>,
<span class=sig-arg>timeout</span>=<span class=sig-default>30</span>)</span>
</h3>
Connect a given client protocol factory to a specific UNIX
socket.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="connectWith"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">connectWith</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>connectorType</span>,
<span class="sig-vararg">*args</span>,
<span class="sig-kwarg">**kw</span>)</span>
</h3>
Start an instance of the given <code>connectorType</code>
connecting.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>connectorType</b></code>
<br /><i>
(type=type which implements <code>IConnector</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="listenSSL"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">listenSSL</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>port</span>,
<span class=sig-arg>factory</span>,
<span class=sig-arg>ctxFactory</span>,
<span class=sig-arg>backlog</span>=<span class=sig-default>5</span>,
<span class=sig-arg>interface</span>=<span class=sig-default>''</span>)</span>
</h3>
Connects a given protocol factory to the given numeric TCP/IP port.
The connection is a SSL one, using contexts created by the context
factory.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="listenTCP"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">listenTCP</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>port</span>,
<span class=sig-arg>factory</span>,
<span class=sig-arg>backlog</span>=<span class=sig-default>5</span>,
<span class=sig-arg>interface</span>=<span class=sig-default>''</span>)</span>
</h3>
Connects a given protocol factory to the given numeric TCP/IP
port.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="listenUDP"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">listenUDP</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>port</span>,
<span class=sig-arg>proto</span>,
<span class=sig-arg>interface</span>=<span class=sig-default>''</span>,
<span class=sig-arg>maxPacketSize</span>=<span class=sig-default>8192</span>)</span>
</h3>
Connects a given DatagramProtocol to the given numeric UDP port.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="listenUNIX"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">listenUNIX</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>filename</span>,
<span class=sig-arg>factory</span>,
<span class=sig-arg>backlog</span>=<span class=sig-default>5</span>,
<span class=sig-arg>mode</span>=<span class=sig-default>438</span>)</span>
</h3>
Connects a given protocol factory to the UNIX socket with the given
filename.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="listenWith"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">listenWith</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>portType</span>,
<span class="sig-vararg">*args</span>,
<span class="sig-kwarg">**kw</span>)</span>
</h3>
Start an instance of the given <code>portType</code> listening.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>portType</b></code>
<br /><i>
(type=type which implements <code>IListeningPort</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="logPrefix"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">logPrefix</span>(<span class=sig-arg>self</span>)</span>
</h3>
A log prefix which describes me.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.python.log.Logger.html#logPrefix"><code>twisted.python.log.Logger.logPrefix</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="run"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">run</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>save</span>=<span class=sig-default>1</span>,
<span class=sig-arg>installSignalHandlers</span>=<span class=sig-default>1</span>)</span>
</h3>
run(save=1, installSignalHandlers=1) Run this application, running
the main loop if necessary. If 'save' is true, then when this
Application is shut down, it will be persisted to a pickle.
'installSignalHandlers' is passed through to reactor.run(), the
function that starts the mainloop.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="save"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">save</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>tag</span>=<span class=sig-default>None</span>,
<span class=sig-arg>filename</span>=<span class=sig-default>None</span>,
<span class=sig-arg>passphrase</span>=<span class=sig-default>None</span>)</span>
</h3>
Save a pickle of this application to a file in the current
directory.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setEUID"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setEUID</span>(<span class=sig-arg>self</span>)</span>
</h3>
Retrieve persistent uid/gid pair (if possible) and set the current
process's euid/egid.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setUID"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setUID</span>(<span class=sig-arg>self</span>)</span>
</h3>
Retrieve persistent uid/gid pair (if possible) and set the current
process's uid/gid
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="unlistenSSL"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">unlistenSSL</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>port</span>,
<span class=sig-arg>interface</span>=<span class=sig-default>''</span>)</span>
</h3>
Stop an SSL Port listening on the given interface and port.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="unlistenTCP"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">unlistenTCP</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>port</span>,
<span class=sig-arg>interface</span>=<span class=sig-default>''</span>)</span>
</h3>
Stop a Port listening on the given port and interface.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="unlistenUDP"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">unlistenUDP</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>port</span>,
<span class=sig-arg>interface</span>=<span class=sig-default>''</span>)</span>
</h3>
Stop a DatagramProtocol listening on the given local port and
interface.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="unlistenUNIX"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">unlistenUNIX</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>filename</span>)</span>
</h3>
Stop a Port listening on the given filename.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="unlistenWith"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">unlistenWith</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>portType</span>,
<span class="sig-vararg">*args</span>,
<span class="sig-kwarg">**kw</span>)</span>
</h3>
Stop a Port listening with the given parameters.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="upgradeToVersion1"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">upgradeToVersion1</span>(<span class=sig-arg>self</span>)</span>
</h3>
Version 1 Persistence Upgrade
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="upgradeToVersion2"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">upgradeToVersion2</span>(<span class=sig-arg>self</span>)</span>
</h3>
Version 2 Persistence Upgrade
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="upgradeToVersion3"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">upgradeToVersion3</span>(<span class=sig-arg>self</span>)</span>
</h3>
Version 3 Persistence Upgrade
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="upgradeToVersion4"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">upgradeToVersion4</span>(<span class=sig-arg>self</span>)</span>
</h3>
Version 4 Persistence Upgrade
<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="_authorizer"></a>
<h3>_authorizer</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>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_boundPorts"></a>
<h3>_boundPorts</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="persistenceVersion"></a>
<h3>persistenceVersion</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="12"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
12 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="persistStyle"></a>
<h3>persistStyle</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'pickle'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>pickle<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="processName"></a>
<h3>processName</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>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="running"></a>
<h3>running</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>
<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:07:38 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>