twisted.internet.app.MultiService.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.MultiService</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 MultiService
</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.MultiService.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class MultiService</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.persisted.styles.Versioned.html"><code>Versioned</code></a> --+ |
| |
<a href="twisted.internet.app.ApplicationService.html"><code>ApplicationService</code></a> --+
|
<b>MultiService</b>
</pre><br />
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="twisted.internet.app.DependentMultiService.html"><code>DependentMultiService</code></a></dd></dl>
<hr/>
<p>I am a collection of multiple services.</p>
I am useful if you have a large number of services and need to
categorize them, or you need to write a protocol that can access multiple
services through one factory, such as a protocol that maps services to
virtual hosts, like POP3.
<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>serviceName</span>,
<span class=summary-sig-arg>serviceParent</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.MultiService.html#_cbAttachServiceNames" class="summary-sig-name"><code>_cbAttachServiceNames</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>result</span>,
<span class=summary-sig-arg>services</span>)</span></code>
<br />
I massage the result of a DeferredList into something that's a bit
easier to work with (see <a
href="twisted.internet.app.MultiService.html#stopService"
class="link"><code>stopService</code></a>'s __doc__).</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.MultiService.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 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.MultiService.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 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.MultiService.html#startService" class="summary-sig-name"><code>startService</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Start all of my Services.</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.MultiService.html#stopService" class="summary-sig-name"><code>stopService</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Stop all of my Services.</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#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 bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from ApplicationService</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.ApplicationService.html#disownServiceParent" class="summary-sig-name"><code>disownServiceParent</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Have my parent disown 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.ApplicationService.html#get_application" class="summary-sig-name"><code>get_application</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="twisted.internet.app.ApplicationService.html#set_application" class="summary-sig-name"><code>set_application</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>application</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.ApplicationService.html#set_application" class="summary-sig-name"><code>setApplication</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>application</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.ApplicationService.html#setServiceParent" class="summary-sig-name"><code>setServiceParent</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>serviceParent</span>)</span></code>
<br />
Set my parent, which must be a service collection of some kind.</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.ApplicationService.html#upgradeToVersion1" class="summary-sig-name"><code>upgradeToVersion1</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</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 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#__getstate__" class="summary-sig-name"><code>__getstate__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>dict</span>)</span></code>
<br />
Get state, adding a version number to it on its way out.</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#__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>
</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 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>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from ApplicationService</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.internet.app.ApplicationService.html#persistenceVersion"><code>persistenceVersion</code></a></b> = <span title="1">1 </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.ApplicationService.html#serviceName"><code>serviceName</code></a></b> = <span title="None">None </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.ApplicationService.html#serviceParent"><code>serviceParent</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.ApplicationService.html#serviceRunning"><code>serviceRunning</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="twisted.internet.app.ApplicationService.html#serviceType"><code>serviceType</code></a></b> = <span title="None">None </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>
</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="_cbAttachServiceNames"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_cbAttachServiceNames</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>result</span>,
<span class=sig-arg>services</span>)</span>
</h3>
I massage the result of a DeferredList into something that's a bit
easier to work with (see <a
href="twisted.internet.app.MultiService.html#stopService"
class="link"><code>stopService</code></a>'s __doc__).
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="addService"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">addService</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>service</span>)</span>
</h3>
Add a Service to me.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.internet.app._AbstractServiceCollection.html#addService"><code>twisted.internet.app._AbstractServiceCollection.addService</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="removeService"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">removeService</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>service</span>)</span>
</h3>
Remove a Service from me.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.internet.app._AbstractServiceCollection.html#removeService"><code>twisted.internet.app._AbstractServiceCollection.removeService</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="startService"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">startService</span>(<span class=sig-arg>self</span>)</span>
</h3>
Start all of my Services.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.internet.app.ApplicationService.html#startService"><code>twisted.internet.app.ApplicationService.startService</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="stopService"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">stopService</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Stop all of my Services.</p>
I return a Deferred that results in a dict that looks like
{serviceObject: (successOrFailure, result)}, where successOrFailure is
a boolean and result is the result of the Deferred returned by
serviceObject.stopService.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.internet.app.ApplicationService.html#stopService"><code>twisted.internet.app.ApplicationService.stopService</code></a></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:08:57 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>