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

« back to all changes in this revision

Viewing changes to doc/api/twisted.application.internet.TCPServer.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.internet.TCPServer</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.internet.html">Module&nbsp;internet</a> ::
 
35
        Class&nbsp;TCPServer
 
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.internet.TCPServer.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 TCPServer</h2>
 
45
 
 
46
<pre class="base-tree">
 
47
         <a href="twisted.application.service.Service.html"><code>Service</code></a> --+        
 
48
                   |        
 
49
<a href="twisted.application.internet._VolatileDataService.html"><code>_VolatileDataService</code></a> --+    
 
50
                       |    
 
51
         <a href="twisted.application.internet._AbstractServer.html"><code>_AbstractServer</code></a> --+
 
52
                           |
 
53
                          <b>TCPServer</b>
 
54
</pre><br />
 
55
 
 
56
<dl><dt><b>Known Subclasses:</b></dt>
 
57
<dd>
 
58
    <a href="twisted.runner.inetdtap.RPCServer.html"><code>RPCServer</code></a></dd></dl>
 
59
 
 
60
<hr/>
 
61
 
 
62
<p>Serve TCP clients</p>
 
63
Call reactor.listenTCP when the service starts, with the arguments 
 
64
given to the constructor. When the service stops, stop listening. See 
 
65
twisted.internet.interfaces for documentation on arguments to the reactor 
 
66
method.
 
67
<hr/>
 
68
 
 
69
 
 
70
<!-- =========== START OF METHOD SUMMARY =========== -->
 
71
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
72
<tr bgcolor="#70b0f0" class="summary">
 
73
  <th colspan="2">Method Summary</th></tr>
 
74
<tr bgcolor="#e8f0f8" class="group">
 
75
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from _AbstractServer</th></tr>
 
76
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
77
  <td><code><span class="summary-sig"><a href="twisted.application.internet._AbstractServer.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
 
78
          <span class="summary-sig-vararg">*args</span>,
 
79
          <span class="summary-sig-kwarg">**kwargs</span>)</span></code>
 
80
</td></tr>
 
81
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
82
  <td><code><span class="summary-sig"><a href="twisted.application.internet._AbstractServer.html#_getPort" class="summary-sig-name"><code>_getPort</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
83
</td></tr>
 
84
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
85
  <td><code><span class="summary-sig"><a href="twisted.application.internet._AbstractServer.html#privilegedStartService" class="summary-sig-name"><code>privilegedStartService</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
86
</td></tr>
 
87
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
88
  <td><code><span class="summary-sig"><a href="twisted.application.internet._AbstractServer.html#startService" class="summary-sig-name"><code>startService</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
89
</td></tr>
 
90
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
91
  <td><code><span class="summary-sig"><a href="twisted.application.internet._AbstractServer.html#stopService" class="summary-sig-name"><code>stopService</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
92
</td></tr>
 
93
<tr bgcolor="#e8f0f8" class="group">
 
94
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from _VolatileDataService</th></tr>
 
95
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
96
  <td><code><span class="summary-sig"><a href="twisted.application.internet._VolatileDataService.html#__getstate__" class="summary-sig-name"><code>__getstate__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
97
</td></tr>
 
98
<tr bgcolor="#e8f0f8" class="group">
 
99
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from Service</th></tr>
 
100
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
101
  <td><code><span class="summary-sig"><a href="twisted.application.service.Service.html#disownServiceParent" class="summary-sig-name"><code>disownServiceParent</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
102
</td></tr>
 
103
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
104
  <td><code><span class="summary-sig"><a href="twisted.application.service.Service.html#setName" class="summary-sig-name"><code>setName</code></a>(<span class=summary-sig-arg>self</span>,
 
105
          <span class=summary-sig-arg>name</span>)</span></code>
 
106
</td></tr>
 
107
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
108
  <td><code><span class="summary-sig"><a href="twisted.application.service.Service.html#setServiceParent" class="summary-sig-name"><code>setServiceParent</code></a>(<span class=summary-sig-arg>self</span>,
 
109
          <span class=summary-sig-arg>parent</span>)</span></code>
 
110
</td></tr>
 
111
</table><br />
 
112
 
 
113
 
 
114
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
 
115
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
116
<tr bgcolor="#70b0f0" class="summary">
 
117
  <th colspan="2">Class Variable Summary</th></tr>
 
118
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
 
119
<td><b><a href="twisted.application.internet.TCPServer.html#method"><code>method</code></a></b> = <span title="'TCP'"><code><span class="variable-quote">'</span>TCP<span class="variable-quote">'</span>                                           </code>
 
120
</span></td></tr>
 
121
<tr bgcolor="#e8f0f8" class="group">
 
122
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from _AbstractServer</th></tr>
 
123
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
 
124
<td><b><a href="twisted.application.internet._AbstractServer.html#privileged"><code>privileged</code></a></b> = <span title="1">1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&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>
 
125
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
 
126
<td><b><a href="twisted.application.internet._AbstractServer.html#volatile"><code>volatile</code></a></b> = <span title="['_port']"><code>['_port']                                     </code>
 
127
</span></td></tr>
 
128
<tr bgcolor="#e8f0f8" class="group">
 
129
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from Service</th></tr>
 
130
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
 
131
<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>
 
132
</span></td></tr>
 
133
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
 
134
<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>
 
135
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
 
136
<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>
 
137
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
 
138
<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>
 
139
</table><br />
 
140
 
 
141
 
 
142
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
 
143
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
144
<tr bgcolor="#70b0f0" class="details">
 
145
  <th colspan="2">Class Variable Details</th></tr>
 
146
</table>
 
147
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
148
<a name="method"></a>
 
149
<h3>method</h3>
 
150
<dl>
 
151
  <dt></dt>
 
152
  <dd>
 
153
    <dl>
 
154
      <dt><b>Type:</b></dt>
 
155
      <dd>
 
156
          <code>str</code>
 
157
 
 
158
      </dd>
 
159
<span title="'TCP'">      <dt><b>Value:</b></dt>
 
160
      <dd><table><tr><td>
 
161
<pre class="variable">
 
162
<span class="variable-quote">'</span>TCP<span class="variable-quote">'</span>                                                                  </pre>
 
163
        </td></tr></table></dd>
 
164
</span>    </dl>
 
165
  </dd>
 
166
</dl></td></tr></table>
 
167
<br />
 
168
 
 
169
 
 
170
<!-- =========== START OF NAVBAR =========== -->
 
171
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
172
  <tr valign="center">
 
173
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
174
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
175
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
176
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
177
    <th class="navbar" align="right" width="100%">
 
178
      <table border="0" cellpadding="0" cellspacing="0">
 
179
      <tr><th class="navbar" align="center">
 
180
        <p class="nomargin">
 
181
          <a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted&nbsp;1.3.0rc1</a>
 
182
      </p></th></tr></table>
 
183
    </th>
 
184
  </tr>
 
185
</table>
 
186
 
 
187
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
188
  <tr>
 
189
    <td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:04 2004</font></td>
 
190
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
191
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
 
192
  </tr>
 
193
</table>
 
194
</body>
 
195
</html>