~certify-web-dev/twisted/certify-trunk

« back to all changes in this revision

Viewing changes to doc/api/twisted.application.service.Service.html

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2004-06-21 22:01:11 UTC
  • mto: (2.2.3 sid)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20040621220111-vkf909euqnyrp3nr
Tags: upstream-1.3.0
ImportĀ upstreamĀ versionĀ 1.3.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
3
          "DTD/xhtml1-transitional.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<head>
 
6
  <title>twisted.application.service.Service</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
 
8
</head>
 
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
10
      alink="#204080">
 
11
 
 
12
<!-- =========== START OF NAVBAR =========== -->
 
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
14
  <tr valign="center">
 
15
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
16
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
17
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
18
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
19
    <th class="navbar" align="right" width="100%">
 
20
      <table border="0" cellpadding="0" cellspacing="0">
 
21
      <tr><th class="navbar" align="center">
 
22
        <p class="nomargin">
 
23
          <a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted&nbsp;1.3.0rc1</a>
 
24
      </p></th></tr></table>
 
25
    </th>
 
26
  </tr>
 
27
</table>
 
28
<table width="100%" cellpadding="0" cellspacing="0">
 
29
  <tr valign="top">
 
30
    <td width="100%">
 
31
      <font size="-1"><b class="breadcrumbs">
 
32
        <a href="twisted.html">Package&nbsp;twisted</a> ::
 
33
        <a href="twisted.application.html">Package&nbsp;application</a> ::
 
34
        <a href="twisted.application.service.html">Module&nbsp;service</a> ::
 
35
        Class&nbsp;Service
 
36
      </b></font></br>
 
37
    </td>
 
38
    <td><table cellpadding="0" cellspacing="0">
 
39
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="twisted.application.service.Service.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
 
40
    </table></td>
 
41
</tr></table>
 
42
 
 
43
<!-- =========== START OF CLASS DESCRIPTION =========== -->
 
44
<h2 class="class">Class Service</h2>
 
45
 
 
46
<dl><dt><b>Known Subclasses:</b></dt>
 
47
<dd>
 
48
    <a href="twisted.trial.remote._Demo.html"><code>_Demo</code></a>,
 
49
    <a href="twisted.application.internet._VolatileDataService.html"><code>_VolatileDataService</code></a>,
 
50
    <a href="twisted.application.service.MultiService.html"><code>MultiService</code></a>,
 
51
    <a href="twisted.runner.procmon.ProcessMonitor.html"><code>ProcessMonitor</code></a>,
 
52
    <a href="twisted.names.secondary.SecondaryAuthorityService.html"><code>SecondaryAuthorityService</code></a>,
 
53
    <a href="twisted.manhole.service.Service.html"><code>Service</code></a>,
 
54
    <a href="twisted.protocols.jabber.component.Service.html"><code>Service</code></a></dd></dl>
 
55
 
 
56
<hr/>
 
57
 
 
58
<p>Base class for services</p>
 
59
Most services should inherit from this class. It handles the 
 
60
book-keeping reponsibilities of starting and stopping, as well as not 
 
61
serializing this book-keeping information.
 
62
<hr/>
 
63
 
 
64
 
 
65
<!-- =========== START OF METHOD SUMMARY =========== -->
 
66
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
67
<tr bgcolor="#70b0f0" class="summary">
 
68
  <th colspan="2">Method Summary</th></tr>
 
69
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
70
  <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>
 
71
</td></tr>
 
72
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
73
  <td><code><a name="disownServiceParent"></a><span class="summary-sig"><span class="summary-sig-name">disownServiceParent</span>(<span class=summary-sig-arg>self</span>)</span></code>
 
74
</td></tr>
 
75
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
76
  <td><code><a name="privilegedStartService"></a><span class="summary-sig"><span class="summary-sig-name">privilegedStartService</span>(<span class=summary-sig-arg>self</span>)</span></code>
 
77
</td></tr>
 
78
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
79
  <td><code><a name="setName"></a><span class="summary-sig"><span class="summary-sig-name">setName</span>(<span class=summary-sig-arg>self</span>,
 
80
          <span class=summary-sig-arg>name</span>)</span></code>
 
81
</td></tr>
 
82
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
83
  <td><code><a name="setServiceParent"></a><span class="summary-sig"><span class="summary-sig-name">setServiceParent</span>(<span class=summary-sig-arg>self</span>,
 
84
          <span class=summary-sig-arg>parent</span>)</span></code>
 
85
</td></tr>
 
86
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
87
  <td><code><a name="startService"></a><span class="summary-sig"><span class="summary-sig-name">startService</span>(<span class=summary-sig-arg>self</span>)</span></code>
 
88
</td></tr>
 
89
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
90
  <td><code><a name="stopService"></a><span class="summary-sig"><span class="summary-sig-name">stopService</span>(<span class=summary-sig-arg>self</span>)</span></code>
 
91
</td></tr>
 
92
</table><br />
 
93
 
 
94
 
 
95
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
 
96
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
97
<tr bgcolor="#70b0f0" class="summary">
 
98
  <th colspan="2">Class Variable Summary</th></tr>
 
99
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
 
100
<td><b><a href="twisted.application.service.Service.html#__implements__"><code>__implements__</code></a></b> = <span title="(&lt;class twisted.application.service.IService at 0x866562c&gt;,)"><code>(&lt;class&nbsp;twisted.application.service.ISe<span class="variable-ellipsis">...</span></code>
 
101
</span></td></tr>
 
102
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
 
103
<td><b><a href="twisted.application.service.Service.html#name"><code>name</code></a></b> = <span title="None">None&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td></tr>
 
104
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
 
105
<td><b><a href="twisted.application.service.Service.html#parent"><code>parent</code></a></b> = <span title="None">None&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td></tr>
 
106
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
 
107
<td><b><a href="twisted.application.service.Service.html#running"><code>running</code></a></b> = <span title="0">0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td></tr>
 
108
</table><br />
 
109
 
 
110
 
 
111
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
 
112
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
113
<tr bgcolor="#70b0f0" class="details">
 
114
  <th colspan="2">Class Variable Details</th></tr>
 
115
</table>
 
116
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
117
<a name="__implements__"></a>
 
118
<h3>__implements__</h3>
 
119
<dl>
 
120
  <dt></dt>
 
121
  <dd>
 
122
    <dl>
 
123
      <dt><b>Type:</b></dt>
 
124
      <dd>
 
125
          <code>tuple</code>
 
126
 
 
127
      </dd>
 
128
<span title="(&lt;class twisted.application.service.IService at 0x866562c&gt;,)">      <dt><b>Value:</b></dt>
 
129
      <dd><table><tr><td>
 
130
<pre class="variable">
 
131
(&lt;class twisted.application.service.IService at 0x866562c&gt;,)           </pre>
 
132
        </td></tr></table></dd>
 
133
</span>    </dl>
 
134
  </dd>
 
135
</dl></td></tr></table>
 
136
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
137
<a name="name"></a>
 
138
<h3>name</h3>
 
139
<dl>
 
140
  <dt></dt>
 
141
  <dd>
 
142
    <dl>
 
143
      <dt><b>Type:</b></dt>
 
144
      <dd>
 
145
          <code>NoneType</code>
 
146
 
 
147
      </dd>
 
148
<span title="None">      <dt><b>Value:</b></dt>
 
149
      <dd><table><tr><td>
 
150
<pre class="variable">
 
151
None&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</pre>
 
152
        </td></tr></table></dd>
 
153
</span>    </dl>
 
154
  </dd>
 
155
</dl></td></tr></table>
 
156
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
157
<a name="parent"></a>
 
158
<h3>parent</h3>
 
159
<dl>
 
160
  <dt></dt>
 
161
  <dd>
 
162
    <dl>
 
163
      <dt><b>Type:</b></dt>
 
164
      <dd>
 
165
          <code>NoneType</code>
 
166
 
 
167
      </dd>
 
168
<span title="None">      <dt><b>Value:</b></dt>
 
169
      <dd><table><tr><td>
 
170
<pre class="variable">
 
171
None&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</pre>
 
172
        </td></tr></table></dd>
 
173
</span>    </dl>
 
174
  </dd>
 
175
</dl></td></tr></table>
 
176
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
177
<a name="running"></a>
 
178
<h3>running</h3>
 
179
<dl>
 
180
  <dt></dt>
 
181
  <dd>
 
182
    <dl>
 
183
      <dt><b>Type:</b></dt>
 
184
      <dd>
 
185
          <code>int</code>
 
186
 
 
187
      </dd>
 
188
<span title="0">      <dt><b>Value:</b></dt>
 
189
      <dd><table><tr><td>
 
190
<pre class="variable">
 
191
0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</pre>
 
192
        </td></tr></table></dd>
 
193
</span>    </dl>
 
194
  </dd>
 
195
</dl></td></tr></table>
 
196
<br />
 
197
 
 
198
 
 
199
<!-- =========== START OF NAVBAR =========== -->
 
200
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
201
  <tr valign="center">
 
202
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
203
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
204
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
205
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
206
    <th class="navbar" align="right" width="100%">
 
207
      <table border="0" cellpadding="0" cellspacing="0">
 
208
      <tr><th class="navbar" align="center">
 
209
        <p class="nomargin">
 
210
          <a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted&nbsp;1.3.0rc1</a>
 
211
      </p></th></tr></table>
 
212
    </th>
 
213
  </tr>
 
214
</table>
 
215
 
 
216
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
217
  <tr>
 
218
    <td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:29 2004</font></td>
 
219
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
220
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
 
221
  </tr>
 
222
</table>
 
223
</body>
 
224
</html>