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">
6
<title>twisted.conch.client.unix.SSHUnixProtocol</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12
<!-- =========== START OF NAVBAR =========== -->
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
15
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
16
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
17
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
18
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
19
<th class="navbar" align="right" width="100%">
20
<table border="0" cellpadding="0" cellspacing="0">
21
<tr><th class="navbar" align="center">
23
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
24
</p></th></tr></table>
28
<table width="100%" cellpadding="0" cellspacing="0">
31
<font size="-1"><b class="breadcrumbs">
32
<a href="twisted.html">Package twisted</a> ::
33
<a href="twisted.conch.html">Package conch</a> ::
34
<a href="twisted.conch.client.html">Package client</a> ::
35
<a href="twisted.conch.client.unix.html">Module unix</a> ::
36
Class SSHUnixProtocol
39
<td><table cellpadding="0" cellspacing="0">
40
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.conch.client.unix.SSHUnixProtocol.html" target="_top">no frames</a>]</font></td></tr>
44
<!-- =========== START OF CLASS DESCRIPTION =========== -->
45
<h2 class="class">Class SSHUnixProtocol</h2>
47
<pre class="base-tree">
48
<a href="twisted.persisted.styles.Ephemeral.html"><code>Ephemeral</code></a> --+
50
<a href="twisted.internet.protocol.BaseProtocol.html"><code>BaseProtocol</code></a> --+ |
52
<a href="twisted.internet.protocol.Protocol.html"><code>Protocol</code></a> --+
54
<a href="twisted.spread.banana.Pynana.html"><code>Pynana</code></a> --+
56
<a href="twisted.spread.banana.Canana.html"><code>Canana</code></a> --+
58
<b>SSHUnixProtocol</b>
61
<dl><dt><b>Known Subclasses:</b></dt>
63
<a href="twisted.conch.client.unix.SSHUnixClientProtocol.html"><code>SSHUnixClientProtocol</code></a>,
64
<a href="twisted.conch.client.unix.SSHUnixServerProtocol.html"><code>SSHUnixServerProtocol</code></a></dd></dl>
69
<!-- =========== START OF METHOD SUMMARY =========== -->
70
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
71
<tr bgcolor="#70b0f0" class="summary">
72
<th colspan="2">Method Summary</th></tr>
73
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
74
<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></code>
76
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
77
<td><code><a name="_cbDeferred"></a><span class="summary-sig"><span class="summary-sig-name">_cbDeferred</span>(<span class=summary-sig-arg>self</span>,
78
<span class=summary-sig-arg>result</span>,
79
<span class=summary-sig-arg>di</span>)</span></code>
81
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
82
<td><code><a name="_ebDeferred"></a><span class="summary-sig"><span class="summary-sig-name">_ebDeferred</span>(<span class=summary-sig-arg>self</span>,
83
<span class=summary-sig-arg>reason</span>,
84
<span class=summary-sig-arg>di</span>)</span></code>
86
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
87
<td><code><span class="summary-sig"><a href="twisted.conch.client.unix.SSHUnixProtocol.html#connectionMade" class="summary-sig-name"><code>connectionMade</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
89
Called when a connection is made.</td></tr>
90
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
91
<td><code><span class="summary-sig"><a href="twisted.conch.client.unix.SSHUnixProtocol.html#expressionReceived" class="summary-sig-name"><code>expressionReceived</code></a>(<span class=summary-sig-arg>self</span>,
92
<span class=summary-sig-arg>lst</span>)</span></code>
94
Called when an expression (list, string, or int) is received.</td></tr>
95
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
96
<td><code><a name="msg_callbackDeferred"></a><span class="summary-sig"><span class="summary-sig-name">msg_callbackDeferred</span>(<span class=summary-sig-arg>self</span>,
97
<span class=summary-sig-arg>lst</span>)</span></code>
99
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
100
<td><code><a name="msg_errbackDeferred"></a><span class="summary-sig"><span class="summary-sig-name">msg_errbackDeferred</span>(<span class=summary-sig-arg>self</span>,
101
<span class=summary-sig-arg>lst</span>)</span></code>
103
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
104
<td><code><a name="msg_returnDeferred"></a><span class="summary-sig"><span class="summary-sig-name">msg_returnDeferred</span>(<span class=summary-sig-arg>self</span>,
105
<span class=summary-sig-arg>lst</span>)</span></code>
107
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
108
<td><code><a name="returnDeferredLocal"></a><span class="summary-sig"><span class="summary-sig-name">returnDeferredLocal</span>(<span class=summary-sig-arg>self</span>)</span></code>
110
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
111
<td><code><a name="returnDeferredWire"></a><span class="summary-sig"><span class="summary-sig-name">returnDeferredWire</span>(<span class=summary-sig-arg>self</span>,
112
<span class=summary-sig-arg>d</span>)</span></code>
114
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
115
<td><code><a name="sendMessage"></a><span class="summary-sig"><span class="summary-sig-name">sendMessage</span>(<span class=summary-sig-arg>self</span>,
116
<span class=summary-sig-arg>vocabName</span>,
117
<span class="summary-sig-vararg">*tup</span>)</span></code>
119
<tr bgcolor="#e8f0f8" class="group">
120
<th colspan="2"> Inherited from Canana</th></tr>
121
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
122
<td><code><span class="summary-sig"><a href="twisted.spread.banana.Canana.html#dataReceived" class="summary-sig-name"><code>dataReceived</code></a>(<span class=summary-sig-arg>self</span>,
123
<span class=summary-sig-arg>chunk</span>)</span></code>
125
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
126
<td><code><span class="summary-sig"><a href="twisted.spread.banana.Canana.html#sendEncoded" class="summary-sig-name"><code>sendEncoded</code></a>(<span class=summary-sig-arg>self</span>,
127
<span class=summary-sig-arg>obj</span>)</span></code>
129
<tr bgcolor="#e8f0f8" class="group">
130
<th colspan="2"> Inherited from Pynana</th></tr>
131
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
132
<td><code><span class="summary-sig"><a href="twisted.spread.banana.Pynana.html#_encode" class="summary-sig-name"><code>_encode</code></a>(<span class=summary-sig-arg>self</span>,
133
<span class=summary-sig-arg>obj</span>,
134
<span class=summary-sig-arg>write</span>)</span></code>
136
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
137
<td><code><span class="summary-sig"><a href="twisted.spread.banana.Pynana.html#_selectDialect" class="summary-sig-name"><code>_selectDialect</code></a>(<span class=summary-sig-arg>self</span>,
138
<span class=summary-sig-arg>dialect</span>)</span></code>
140
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
141
<td><code><span class="summary-sig"><a href="twisted.spread.banana.Pynana.html#callExpressionReceived" class="summary-sig-name"><code>callExpressionReceived</code></a>(<span class=summary-sig-arg>self</span>,
142
<span class=summary-sig-arg>obj</span>)</span></code>
144
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
145
<td><code><span class="summary-sig"><a href="twisted.spread.banana.Pynana.html#connectionReady" class="summary-sig-name"><code>connectionReady</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
147
Surrogate for connectionMade Called after protocol negotiation.</td></tr>
148
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
149
<td><code><span class="summary-sig"><a href="twisted.spread.banana.Pynana.html#gotItem" class="summary-sig-name"><code>gotItem</code></a>(<span class=summary-sig-arg>self</span>,
150
<span class=summary-sig-arg>item</span>)</span></code>
152
<tr bgcolor="#e8f0f8" class="group">
153
<th colspan="2"> Inherited from Protocol</th></tr>
154
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
155
<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>
157
(Deprecated)</td></tr>
158
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
159
<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>,
160
<span class=summary-sig-arg>reason</span>)</span></code>
162
Called when the connection is shut down.</td></tr>
163
<tr bgcolor="#e8f0f8" class="group">
164
<th colspan="2"> Inherited from BaseProtocol</th></tr>
165
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
166
<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>,
167
<span class=summary-sig-arg>transport</span>)</span></code>
169
Make a connection to a transport and a server.</td></tr>
170
<tr bgcolor="#e8f0f8" class="group">
171
<th colspan="2"> Inherited from Ephemeral</th></tr>
172
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
173
<td><code><span class="summary-sig"><a href="twisted.persisted.styles.Ephemeral.html#__getstate__" class="summary-sig-name"><code>__getstate__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
175
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
176
<td><code><span class="summary-sig"><a href="twisted.persisted.styles.Ephemeral.html#__setstate__" class="summary-sig-name"><code>__setstate__</code></a>(<span class=summary-sig-arg>self</span>,
177
<span class=summary-sig-arg>state</span>)</span></code>
182
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
183
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
184
<tr bgcolor="#70b0f0" class="summary">
185
<th colspan="2">Class Variable Summary</th></tr>
186
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
187
<td><b><a href="twisted.conch.client.unix.SSHUnixProtocol.html#knownDialects"><code>knownDialects</code></a></b> = <span title="['none']"><code>['none'] </code>
189
<tr bgcolor="#e8f0f8" class="group">
190
<th colspan="2"> Inherited from Pynana</th></tr>
191
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
192
<td><b><a href="twisted.spread.banana.Pynana.html#buffer"><code>buffer</code></a></b> = <span title="''"><code><span class="variable-quote">'</span><span class="variable-quote">'</span> </code>
194
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
195
<td><b><a href="twisted.spread.banana.Pynana.html#incomingVocabulary"><code>incomingVocabulary</code></a></b> = <span title="{1: 'None', 2: 'class', 3: 'dereference', 4: 'reference', 5: 'dictionary', 6: 'function', 7: 'instance', 8: 'list', 9: 'module', 10: 'persistent', 11: 'tuple', 12: 'unpersistable', 13: 'copy', 14: 'cache', 15: 'cached', 16: 'remote', 17: 'local', 18: 'lcache', 19: 'version', 20: 'login', 21: 'password', 22: 'challenge', 23: 'logged_in', 24: 'not_logged_in', 25: 'cachemessage', 26: 'message', 27: 'answer', 28: 'error', 29: 'decref', 30: 'decache', 31: 'uncache'}"><code>{1: 'None', 2: 'class', 3: 'derefer<span class="variable-ellipsis">...</span></code>
197
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
198
<td><b><a href="twisted.spread.banana.Pynana.html#k"><code>k</code></a></b> = <span title="'lcache'"><code><span class="variable-quote">'</span>lcache<span class="variable-quote">'</span> </code>
200
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
201
<td><b><a href="twisted.spread.banana.Pynana.html#outgoingVocabulary"><code>outgoingVocabulary</code></a></b> = <span title="{'function': 6, 'None': 1, 'dictionary': 5, 'tuple': 11, 'uncache': 31, 'dereference': 3, 'module': 9, 'not_logged_in': 24, 'message': 26, 'password': 21, 'class': 2, 'decref': 29, 'decache': 30, 'copy': 13, 'remote': 16, 'reference': 4, 'cached': 15, 'local': 17, 'challenge': 22, 'cache': 14, 'list': 8, 'persistent': 10, 'unpersistable': 12, 'instance': 7, 'version': 19, 'error': 28, 'cachemessage': 25, 'answer': 27, 'logged_in': 23, 'login': 20, 'lcache': 18}"><code>{'function': 6, 'None': 1, 'diction<span class="variable-ellipsis">...</span></code>
203
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
204
<td><b><a href="twisted.spread.banana.Pynana.html#v"><code>v</code></a></b> = <span title="18">18 </span></td></tr>
205
<tr bgcolor="#e8f0f8" class="group">
206
<th colspan="2"> Inherited from Protocol</th></tr>
207
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
208
<td><b><a href="twisted.internet.protocol.Protocol.html#__implements__"><code>__implements__</code></a></b> = <span title="(<class twisted.internet.interfaces.IProtocol at 0x8278f0c>,)"><code>(<class twisted.internet.interfaces.IPr<span class="variable-ellipsis">...</span></code>
210
<tr bgcolor="#e8f0f8" class="group">
211
<th colspan="2"> Inherited from BaseProtocol</th></tr>
212
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
213
<td><b><a href="twisted.internet.protocol.BaseProtocol.html#connected"><code>connected</code></a></b> = <span title="0">0 </span></td></tr>
214
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
215
<td><b><a href="twisted.internet.protocol.BaseProtocol.html#transport"><code>transport</code></a></b> = <span title="None">None </span></td></tr>
219
<!-- =========== START OF METHOD DETAILS =========== -->
220
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
221
<tr bgcolor="#70b0f0" class="details">
222
<th colspan="2">Method Details</th></tr>
225
<a name="connectionMade"></a>
226
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
227
<h3><span class="sig"><span class="sig-name">connectionMade</span>(<span class=sig-arg>self</span>)</span>
229
<p>Called when a connection is made.</p>
230
This may be considered the initializer of the protocol, because it
231
is called when the connection is completed. For clients, this is called
232
once the connection to the server has been established; for servers,
233
this is called after an accept() call stops blocking and a socket has
234
been received. If you need to send any greeting or initial message, do
237
<dl><dt><b>Overrides:</b></dt>
238
<dd><a href="twisted.spread.banana.Canana.html#connectionMade"><code>twisted.spread.banana.Canana.connectionMade</code></a> <i>(inherited documentation)</i>
244
<a name="expressionReceived"></a>
245
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
246
<h3><span class="sig"><span class="sig-name">expressionReceived</span>(<span class=sig-arg>self</span>,
247
<span class=sig-arg>lst</span>)</span>
249
Called when an expression (list, string, or int) is received.
251
<dl><dt><b>Overrides:</b></dt>
252
<dd><a href="twisted.spread.banana.Pynana.html#expressionReceived"><code>twisted.spread.banana.Pynana.expressionReceived</code></a> <i>(inherited documentation)</i>
260
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
261
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
262
<tr bgcolor="#70b0f0" class="details">
263
<th colspan="2">Class Variable Details</th></tr>
265
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
266
<a name="knownDialects"></a>
267
<h3>knownDialects</h3>
272
<dt><b>Type:</b></dt>
277
<span title="['none']"> <dt><b>Value:</b></dt>
279
<pre class="variable">
281
</td></tr></table></dd>
284
</dl></td></tr></table>
288
<!-- =========== START OF NAVBAR =========== -->
289
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
291
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
292
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
293
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
294
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
295
<th class="navbar" align="right" width="100%">
296
<table border="0" cellpadding="0" cellspacing="0">
297
<tr><th class="navbar" align="center">
299
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
300
</p></th></tr></table>
305
<table border="0" cellpadding="0" cellspacing="0" width="100%">
307
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:14 2004</font></td>
308
<td align="right"><a href="http://epydoc.sourceforge.net"
309
><font size="-2">http://epydoc.sf.net</font></a></td>