twisted.application.service.IServiceCollection.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.IServiceCollection</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> ::
<a href="twisted.application.service.html">Module service</a> ::
Class IServiceCollection
</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.IServiceCollection.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class IServiceCollection</h2>
<pre class="base-tree">
<a href="twisted.python.components.Interface.html"><code>Interface</code></a> --+
|
<b>IServiceCollection</b>
</pre><br />
<hr/>
<p>Collection of services.</p>
Contain several services, and manage their start-up/shut-down.
Services can be accessed by name if they have a name, and it is always
possible to iterate over 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="twisted.application.service.IServiceCollection.html#__iter__" class="summary-sig-name"><code>__iter__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Get an iterator over all child 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.application.service.IServiceCollection.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 child service.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>IService</code> @raise <code>KeyError</code>: Raised
if the service has no child with the given name.
</font></td>
<td><code><span class="summary-sig"><a href="twisted.application.service.IServiceCollection.html#getServiceNamed" class="summary-sig-name"><code>getServiceNamed</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
<br />
Get the child service with a given name.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>Deferred</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.application.service.IServiceCollection.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 child service.</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="__iter__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__iter__</span>(<span class=sig-arg>self</span>)</span>
</h3>
Get an iterator over all child services
<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 child service.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>service</b></code>
<br /><i>
(type=<code>IService</code> @raise
<code>RuntimeError</code>: Raised if the service has a
child with the given name.)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getServiceNamed"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getServiceNamed</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>name</span>)</span>
</h3>
Get the child service with a given name.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>name</b></code>
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>IService</code> @raise <code>KeyError</code>: Raised
if the service has no child with the given name.
</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 child service.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>service</b></code>
<br /><i>
(type=<code>IService</code> @raise
<code>ValueError</code>: Raised if the given service is not
a child.)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
a deferred which is triggered when the service has finished
shutting down. If shutting down is immediate, a value can be
returned (usually, None).
<br /><i>
(type=<code>Deferred</code>)</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:39 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>