twisted.application.service.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.service</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 service
</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.service.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.application.service</h2>
<p>Service architecture for Twisted</p>
<p>Services are arranged in a hierarchy. At the leafs of the hierarchy,
the services which actually interact with the outside world are started.
Services can be named or anonymous -- usually, they will be named if
there is need to access them through the hierarchy (from a parent or a
sibling).</p>
<p>API Stability: unstable</p>
Maintainer: <a href="mailto:moshez@twistedmatrix.com">Moshe
Zadka</a>
<hr/>
<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Classes</th></tr>
<tr><td width="15%">
<b><a href="twisted.application.service.IProcess.html"><code>IProcess</code></a></b></td>
<td>Process running parameters</td></tr>
<tr><td width="15%">
<b><a href="twisted.application.service.IService.html"><code>IService</code></a></b></td>
<td>A service.</td></tr>
<tr><td width="15%">
<b><a href="twisted.application.service.IServiceCollection.html"><code>IServiceCollection</code></a></b></td>
<td>Collection of services.</td></tr>
<tr><td width="15%">
<b><a href="twisted.application.service.MultiService.html"><code>MultiService</code></a></b></td>
<td>Straightforward Service Container</td></tr>
<tr><td width="15%">
<b><a href="twisted.application.service.Process.html"><code>Process</code></a></b></td>
<td>Process running parameters</td></tr>
<tr><td width="15%">
<b><a href="twisted.application.service.Service.html"><code>Service</code></a></b></td>
<td>Base class for services</td></tr>
</table><br />
<!-- =========== 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><span class="summary-sig"><a href="twisted.application.service.html#Application" class="summary-sig-name"><code>Application</code></a>(<span class=summary-sig-arg>name</span>,
<span class=summary-sig-arg>uid</span>,
<span class=summary-sig-arg>gid</span>)</span></code>
<br />
Return a compound class.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.application.service.html#loadApplication" class="summary-sig-name"><code>loadApplication</code></a>(<span class=summary-sig-arg>filename</span>,
<span class=summary-sig-arg>kind</span>,
<span class=summary-sig-arg>passphrase</span>)</span></code>
<br />
Load Application from file</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="Application"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">Application</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>
</h3>
<p>Return a compound class.</p>
Return an object supporting the <code>IService</code>,
<code>IServiceCollection</code>, <code>IProcess</code> and
<code>sob.IPersistable</code> interfaces, with the given parameters.
Always access the return value by explicit casting to one of the
interfaces.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="loadApplication"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">loadApplication</span>(<span class=sig-arg>filename</span>,
<span class=sig-arg>kind</span>,
<span class=sig-arg>passphrase</span>=<span class=sig-default>None</span>)</span>
</h3>
Load Application from file
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>filename</b></code>
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>kind</b></code>
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>passphrase</b></code>
<br /><i>
(type=<p><code>str</code></p>
Load application from a given file. The serialization
format it was saved in should be given as
<code>kind</code>, and is one of 'pickle', 'source', 'xml'
or 'python'. If <code>passphrase</code> is given, the
application was encrypted with the given passphrase.)</i>
</dd>
</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:59 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>