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

« back to all changes in this revision

Viewing changes to doc/api/twisted.protocols.finger.Finger.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.protocols.finger.Finger</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.protocols.html">Package&nbsp;protocols</a> ::
 
34
        <a href="twisted.protocols.finger.html">Module&nbsp;finger</a> ::
 
35
        Class&nbsp;Finger
 
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.protocols.finger.Finger.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 Finger</h2>
 
45
 
 
46
<pre class="base-tree">
 
47
<a href="twisted.internet.protocol.BaseProtocol.html"><code>BaseProtocol</code></a> --+        
 
48
               |        
 
49
        <a href="twisted.internet.protocol.Protocol.html"><code>Protocol</code></a> --+    
 
50
                   |    
 
51
        <a href="twisted.protocols.basic.LineReceiver.html"><code>LineReceiver</code></a> --+
 
52
                       |
 
53
                      <b>Finger</b>
 
54
</pre><br />
 
55
 
 
56
<hr/>
 
57
 
 
58
 
 
59
<!-- =========== START OF METHOD SUMMARY =========== -->
 
60
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
61
<tr bgcolor="#70b0f0" class="summary">
 
62
  <th colspan="2">Method Summary</th></tr>
 
63
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
64
  <td><code><a name="_refuseMessage"></a><span class="summary-sig"><span class="summary-sig-name">_refuseMessage</span>(<span class=summary-sig-arg>self</span>,
 
65
          <span class=summary-sig-arg>message</span>)</span></code>
 
66
</td></tr>
 
67
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
68
  <td><code><a name="forwardQuery"></a><span class="summary-sig"><span class="summary-sig-name">forwardQuery</span>(<span class=summary-sig-arg>self</span>,
 
69
          <span class=summary-sig-arg>slash_w</span>,
 
70
          <span class=summary-sig-arg>user</span>,
 
71
          <span class=summary-sig-arg>host</span>)</span></code>
 
72
</td></tr>
 
73
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
74
  <td><code><a name="getDomain"></a><span class="summary-sig"><span class="summary-sig-name">getDomain</span>(<span class=summary-sig-arg>self</span>,
 
75
          <span class=summary-sig-arg>slash_w</span>)</span></code>
 
76
</td></tr>
 
77
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
78
  <td><code><a name="getUser"></a><span class="summary-sig"><span class="summary-sig-name">getUser</span>(<span class=summary-sig-arg>self</span>,
 
79
          <span class=summary-sig-arg>slash_w</span>,
 
80
          <span class=summary-sig-arg>user</span>)</span></code>
 
81
</td></tr>
 
82
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
83
  <td><code><span class="summary-sig"><a href="twisted.protocols.finger.Finger.html#lineReceived" class="summary-sig-name"><code>lineReceived</code></a>(<span class=summary-sig-arg>self</span>,
 
84
          <span class=summary-sig-arg>line</span>)</span></code>
 
85
<br />
 
86
Override this for when each line is received.</td></tr>
 
87
<tr bgcolor="#e8f0f8" class="group">
 
88
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from LineReceiver</th></tr>
 
89
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
90
  <td><code><span class="summary-sig"><a href="twisted.protocols.basic.LineReceiver.html#clearLineBuffer" class="summary-sig-name"><code>clearLineBuffer</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
91
<br />
 
92
Clear buffered data.</td></tr>
 
93
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
94
  <td><code><span class="summary-sig"><a href="twisted.protocols.basic.LineReceiver.html#dataReceived" class="summary-sig-name"><code>dataReceived</code></a>(<span class=summary-sig-arg>self</span>,
 
95
          <span class=summary-sig-arg>data</span>)</span></code>
 
96
<br />
 
97
Protocol.dataReceived.</td></tr>
 
98
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
99
  <td><code><span class="summary-sig"><a href="twisted.protocols.basic.LineReceiver.html#lineLengthExceeded" class="summary-sig-name"><code>lineLengthExceeded</code></a>(<span class=summary-sig-arg>self</span>,
 
100
          <span class=summary-sig-arg>line</span>)</span></code>
 
101
<br />
 
102
Called when the maximum line length has been reached.</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.protocols.basic.LineReceiver.html#rawDataReceived" class="summary-sig-name"><code>rawDataReceived</code></a>(<span class=summary-sig-arg>self</span>,
 
105
          <span class=summary-sig-arg>data</span>)</span></code>
 
106
<br />
 
107
Override this for when raw data is received.</td></tr>
 
108
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
109
  <td><code><span class="summary-sig"><a href="twisted.protocols.basic.LineReceiver.html#sendLine" class="summary-sig-name"><code>sendLine</code></a>(<span class=summary-sig-arg>self</span>,
 
110
          <span class=summary-sig-arg>line</span>)</span></code>
 
111
<br />
 
112
Sends a line to the other end of the connection.</td></tr>
 
113
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
114
  <td><code><span class="summary-sig"><a href="twisted.protocols.basic.LineReceiver.html#setLineMode" class="summary-sig-name"><code>setLineMode</code></a>(<span class=summary-sig-arg>self</span>,
 
115
          <span class=summary-sig-arg>extra</span>)</span></code>
 
116
<br />
 
117
Sets the line-mode of this receiver.</td></tr>
 
118
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
119
  <td><code><span class="summary-sig"><a href="twisted.protocols.basic.LineReceiver.html#setRawMode" class="summary-sig-name"><code>setRawMode</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
120
<br />
 
121
Sets the raw mode of this receiver.</td></tr>
 
122
<tr bgcolor="#e8f0f8" class="group">
 
123
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from Protocol</th></tr>
 
124
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
125
  <td><code><span class="summary-sig"><a href="twisted.internet.protocol.Protocol.html#connectionFailed" class="summary-sig-name"><code>connectionFailed</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
126
<br />
 
127
(Deprecated)</td></tr>
 
128
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
129
  <td><code><span class="summary-sig"><a href="twisted.internet.protocol.Protocol.html#connectionLost" class="summary-sig-name"><code>connectionLost</code></a>(<span class=summary-sig-arg>self</span>,
 
130
          <span class=summary-sig-arg>reason</span>)</span></code>
 
131
<br />
 
132
Called when the connection is shut down.</td></tr>
 
133
<tr bgcolor="#e8f0f8" class="group">
 
134
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from BaseProtocol</th></tr>
 
135
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
136
  <td><code><span class="summary-sig"><a href="twisted.internet.protocol.BaseProtocol.html#connectionMade" class="summary-sig-name"><code>connectionMade</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
137
<br />
 
138
Called when a connection is made.</td></tr>
 
139
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
140
  <td><code><span class="summary-sig"><a href="twisted.internet.protocol.BaseProtocol.html#makeConnection" class="summary-sig-name"><code>makeConnection</code></a>(<span class=summary-sig-arg>self</span>,
 
141
          <span class=summary-sig-arg>transport</span>)</span></code>
 
142
<br />
 
143
Make a connection to a transport and a server.</td></tr>
 
144
</table><br />
 
145
 
 
146
 
 
147
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
 
148
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
149
<tr bgcolor="#70b0f0" class="summary">
 
150
  <th colspan="2">Class Variable Summary</th></tr>
 
151
<tr bgcolor="#e8f0f8" class="group">
 
152
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from LineReceiver</th></tr>
 
153
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
 
154
<td><b><a href="twisted.protocols.basic.LineReceiver.html#__buffer"><code>_LineReceiver__buffer</code></a></b> = <span title="''"><code><span class="variable-quote">'</span><span class="variable-quote">'</span>                               </code>
 
155
</span></td></tr>
 
156
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
 
157
<td><b><a href="twisted.protocols.basic.LineReceiver.html#delimiter"><code>delimiter</code></a></b>: The line-ending delimiter to use.</td></tr>
 
158
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
 
159
<td><b><a href="twisted.protocols.basic.LineReceiver.html#line_mode"><code>line_mode</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>
 
160
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
 
161
<td><b><a href="twisted.protocols.basic.LineReceiver.html#MAX_LENGTH"><code>MAX_LENGTH</code></a></b>: The maximum length of a line to allow (If a sent line is longer than 
 
162
this, the connection is dropped).</td></tr>
 
163
<tr bgcolor="#e8f0f8" class="group">
 
164
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from Protocol</th></tr>
 
165
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
 
166
<td><b><a href="twisted.internet.protocol.Protocol.html#__implements__"><code>__implements__</code></a></b> = <span title="(&lt;class twisted.internet.interfaces.IProtocol at 0x8278f0c&gt;,)"><code>(&lt;class&nbsp;twisted.internet.interfaces.IPr<span class="variable-ellipsis">...</span></code>
 
167
</span></td></tr>
 
168
<tr bgcolor="#e8f0f8" class="group">
 
169
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from BaseProtocol</th></tr>
 
170
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
 
171
<td><b><a href="twisted.internet.protocol.BaseProtocol.html#connected"><code>connected</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>
 
172
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
 
173
<td><b><a href="twisted.internet.protocol.BaseProtocol.html#transport"><code>transport</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>
 
174
</table><br />
 
175
 
 
176
 
 
177
<!-- =========== START OF METHOD DETAILS =========== -->
 
178
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
179
<tr bgcolor="#70b0f0" class="details">
 
180
  <th colspan="2">Method Details</th></tr>
 
181
</table>
 
182
 
 
183
<a name="lineReceived"></a>
 
184
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
185
  <h3><span class="sig"><span class="sig-name">lineReceived</span>(<span class=sig-arg>self</span>,
 
186
          <span class=sig-arg>line</span>)</span>
 
187
  </h3>
 
188
  Override this for when each line is received.
 
189
  <dl><dt></dt><dd>
 
190
    <dl><dt><b>Overrides:</b></dt>
 
191
      <dd><a href="twisted.protocols.basic.LineReceiver.html#lineReceived"><code>twisted.protocols.basic.LineReceiver.lineReceived</code></a> <i>(inherited documentation)</i>
 
192
</dd>
 
193
    </dl>
 
194
  </dd></dl>
 
195
</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:07:45 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>