|
2
by Jeremy T. Bouse
Imported Upstream version 1.7.4 |
1 |
<?xml version="1.0" encoding="ascii"?>
|
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>paramiko.Message</title> |
|
7 |
<link rel="stylesheet" href="epydoc.css" type="text/css" /> |
|
8 |
<script type="text/javascript" src="epydoc.js"></script> |
|
9 |
</head> |
|
10 |
||
11 |
<body bgcolor="white" text="black" link="blue" vlink="#204080" |
|
12 |
alink="#204080"> |
|
13 |
<!-- ==================== NAVIGATION BAR ==================== -->
|
|
14 |
<table class="navbar" border="0" width="100%" cellpadding="0" |
|
15 |
bgcolor="#a0c0ff" cellspacing="0"> |
|
16 |
<tr valign="middle"> |
|
17 |
<!-- Home link -->
|
|
18 |
<th> <a |
|
19 |
href="paramiko-module.html">Home</a> </th> |
|
20 |
||
21 |
<!-- Tree link -->
|
|
22 |
<th> <a |
|
23 |
href="module-tree.html">Trees</a> </th> |
|
24 |
||
25 |
<!-- Index link -->
|
|
26 |
<th> <a |
|
27 |
href="identifier-index.html">Indices</a> </th> |
|
28 |
||
29 |
<!-- Help link -->
|
|
30 |
<th> <a |
|
31 |
href="help.html">Help</a> </th> |
|
32 |
||
33 |
<th class="navbar" width="100%"></th> |
|
34 |
</tr> |
|
35 |
</table> |
|
36 |
<table width="100%" cellpadding="0" cellspacing="0"> |
|
37 |
<tr valign="top"> |
|
38 |
<td width="100%"> |
|
39 |
<span class="breadcrumbs"> |
|
40 |
<a href="paramiko-module.html">Package paramiko</a> :: |
|
41 |
Class Message
|
|
42 |
</span> |
|
43 |
</td> |
|
44 |
<td> |
|
45 |
<table cellpadding="0" cellspacing="0"> |
|
46 |
<!-- hide/show private -->
|
|
47 |
<tr><td align="right"><span class="options" |
|
48 |
>[<a href="frames.html" target="_top">frames</a |
|
49 |
>] | <a href="paramiko.Message-class.html" |
|
50 |
target="_top">no frames</a>]</span></td></tr> |
|
51 |
</table> |
|
52 |
</td> |
|
53 |
</tr> |
|
54 |
</table> |
|
55 |
<!-- ==================== CLASS DESCRIPTION ==================== -->
|
|
56 |
<h1 class="epydoc">Class Message</h1><p class="nomargin-top"><span class="codelink"><a href="paramiko-pysrc.html#Message">source code</a></span></p> |
|
57 |
<pre class="base-tree"> |
|
58 |
object --+ |
|
59 |
| |
|
60 |
<strong class="uidshort">Message</strong> |
|
61 |
</pre> |
|
62 |
||
63 |
<hr /> |
|
64 |
<p>An SSH2 <i>Message</i> is a stream of bytes that encodes some |
|
65 |
combination of strings, integers, bools, and infinite-precision integers |
|
66 |
(known in python as <i>long</i>s). This class builds or breaks down such |
|
67 |
a byte stream.</p> |
|
68 |
<p>Normally you don't need to deal with anything this low-level, but it's |
|
69 |
exposed for people implementing custom extensions, or features that |
|
70 |
paramiko doesn't support yet.</p> |
|
71 |
||
72 |
<!-- ==================== INSTANCE METHODS ==================== -->
|
|
73 |
<a name="section-InstanceMethods"></a> |
|
74 |
<table class="summary" border="1" cellpadding="3" |
|
75 |
cellspacing="0" width="100%" bgcolor="white"> |
|
76 |
<tr bgcolor="#70b0f0" class="table-header"> |
|
77 |
<td align="left" colspan="2" class="table-header"> |
|
78 |
<span class="table-header">Instance Methods</span></td> |
|
79 |
</tr> |
|
80 |
<tr> |
|
81 |
<td width="15%" align="right" valign="top" class="summary"> |
|
82 |
<span class="summary-type"> </span> |
|
83 |
</td><td class="summary"> |
|
84 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
85 |
<tr> |
|
86 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
|
87 |
<span class="summary-sig-arg">content</span>=<span class="summary-sig-default">None</span>)</span><br /> |
|
88 |
Create a new SSH2 Message.</td> |
|
89 |
<td align="right" valign="top"> |
|
90 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
91 |
||
92 |
</td> |
|
93 |
</tr> |
|
94 |
</table> |
|
95 |
||
96 |
</td> |
|
97 |
</tr> |
|
98 |
<tr> |
|
99 |
<td width="15%" align="right" valign="top" class="summary"> |
|
100 |
<span class="summary-type">string</span> |
|
101 |
</td><td class="summary"> |
|
102 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
103 |
<tr> |
|
104 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
105 |
Returns a string representation of this object, for debugging.</td> |
|
106 |
<td align="right" valign="top"> |
|
107 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
108 |
||
109 |
</td> |
|
110 |
</tr> |
|
111 |
</table> |
|
112 |
||
113 |
</td> |
|
114 |
</tr> |
|
115 |
<tr> |
|
116 |
<td width="15%" align="right" valign="top" class="summary"> |
|
117 |
<span class="summary-type">string</span> |
|
118 |
</td><td class="summary"> |
|
119 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
120 |
<tr> |
|
121 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
122 |
Return the byte stream content of this Message, as a string.</td> |
|
123 |
<td align="right" valign="top"> |
|
124 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
125 |
||
126 |
</td> |
|
127 |
</tr> |
|
128 |
</table> |
|
129 |
||
130 |
</td> |
|
131 |
</tr> |
|
132 |
<tr> |
|
133 |
<td width="15%" align="right" valign="top" class="summary"> |
|
134 |
<span class="summary-type"> </span> |
|
135 |
</td><td class="summary"> |
|
136 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
137 |
<tr> |
|
138 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#add" class="summary-sig-name">add</a>(<span class="summary-sig-arg">self</span>, |
|
139 |
<span class="summary-sig-arg">*seq</span>)</span><br /> |
|
140 |
Add a sequence of items to the stream.</td> |
|
141 |
<td align="right" valign="top"> |
|
142 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
143 |
||
144 |
</td> |
|
145 |
</tr> |
|
146 |
</table> |
|
147 |
||
148 |
</td> |
|
149 |
</tr> |
|
150 |
<tr> |
|
151 |
<td width="15%" align="right" valign="top" class="summary"> |
|
152 |
<span class="summary-type"> </span> |
|
153 |
</td><td class="summary"> |
|
154 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
155 |
<tr> |
|
156 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#add_boolean" class="summary-sig-name">add_boolean</a>(<span class="summary-sig-arg">self</span>, |
|
157 |
<span class="summary-sig-arg">b</span>)</span><br /> |
|
158 |
Add a boolean value to the stream.</td> |
|
159 |
<td align="right" valign="top"> |
|
160 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
161 |
||
162 |
</td> |
|
163 |
</tr> |
|
164 |
</table> |
|
165 |
||
166 |
</td> |
|
167 |
</tr> |
|
168 |
<tr> |
|
169 |
<td width="15%" align="right" valign="top" class="summary"> |
|
170 |
<span class="summary-type"> </span> |
|
171 |
</td><td class="summary"> |
|
172 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
173 |
<tr> |
|
174 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#add_byte" class="summary-sig-name">add_byte</a>(<span class="summary-sig-arg">self</span>, |
|
175 |
<span class="summary-sig-arg">b</span>)</span><br /> |
|
176 |
Write a single byte to the stream, without any formatting.</td> |
|
177 |
<td align="right" valign="top"> |
|
178 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
179 |
||
180 |
</td> |
|
181 |
</tr> |
|
182 |
</table> |
|
183 |
||
184 |
</td> |
|
185 |
</tr> |
|
186 |
<tr> |
|
187 |
<td width="15%" align="right" valign="top" class="summary"> |
|
188 |
<span class="summary-type"> </span> |
|
189 |
</td><td class="summary"> |
|
190 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
191 |
<tr> |
|
192 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#add_bytes" class="summary-sig-name">add_bytes</a>(<span class="summary-sig-arg">self</span>, |
|
193 |
<span class="summary-sig-arg">b</span>)</span><br /> |
|
194 |
Write bytes to the stream, without any formatting.</td> |
|
195 |
<td align="right" valign="top"> |
|
196 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
197 |
||
198 |
</td> |
|
199 |
</tr> |
|
200 |
</table> |
|
201 |
||
202 |
</td> |
|
203 |
</tr> |
|
204 |
<tr> |
|
205 |
<td width="15%" align="right" valign="top" class="summary"> |
|
206 |
<span class="summary-type"> </span> |
|
207 |
</td><td class="summary"> |
|
208 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
209 |
<tr> |
|
210 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#add_int" class="summary-sig-name">add_int</a>(<span class="summary-sig-arg">self</span>, |
|
211 |
<span class="summary-sig-arg">n</span>)</span><br /> |
|
212 |
Add an integer to the stream.</td> |
|
213 |
<td align="right" valign="top"> |
|
214 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
215 |
||
216 |
</td> |
|
217 |
</tr> |
|
218 |
</table> |
|
219 |
||
220 |
</td> |
|
221 |
</tr> |
|
222 |
<tr> |
|
223 |
<td width="15%" align="right" valign="top" class="summary"> |
|
224 |
<span class="summary-type"> </span> |
|
225 |
</td><td class="summary"> |
|
226 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
227 |
<tr> |
|
228 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#add_int64" class="summary-sig-name">add_int64</a>(<span class="summary-sig-arg">self</span>, |
|
229 |
<span class="summary-sig-arg">n</span>)</span><br /> |
|
230 |
Add a 64-bit int to the stream.</td> |
|
231 |
<td align="right" valign="top"> |
|
232 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
233 |
||
234 |
</td> |
|
235 |
</tr> |
|
236 |
</table> |
|
237 |
||
238 |
</td> |
|
239 |
</tr> |
|
240 |
<tr> |
|
241 |
<td width="15%" align="right" valign="top" class="summary"> |
|
242 |
<span class="summary-type"> </span> |
|
243 |
</td><td class="summary"> |
|
244 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
245 |
<tr> |
|
246 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#add_list" class="summary-sig-name">add_list</a>(<span class="summary-sig-arg">self</span>, |
|
247 |
<span class="summary-sig-arg">l</span>)</span><br /> |
|
248 |
Add a list of strings to the stream.</td> |
|
249 |
<td align="right" valign="top"> |
|
250 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
251 |
||
252 |
</td> |
|
253 |
</tr> |
|
254 |
</table> |
|
255 |
||
256 |
</td> |
|
257 |
</tr> |
|
258 |
<tr> |
|
259 |
<td width="15%" align="right" valign="top" class="summary"> |
|
260 |
<span class="summary-type"> </span> |
|
261 |
</td><td class="summary"> |
|
262 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
263 |
<tr> |
|
264 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#add_mpint" class="summary-sig-name">add_mpint</a>(<span class="summary-sig-arg">self</span>, |
|
265 |
<span class="summary-sig-arg">z</span>)</span><br /> |
|
266 |
Add a long int to the stream, encoded as an infinite-precision |
|
267 |
integer.</td> |
|
268 |
<td align="right" valign="top"> |
|
269 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
270 |
||
271 |
</td> |
|
272 |
</tr> |
|
273 |
</table> |
|
274 |
||
275 |
</td> |
|
276 |
</tr> |
|
277 |
<tr> |
|
278 |
<td width="15%" align="right" valign="top" class="summary"> |
|
279 |
<span class="summary-type"> </span> |
|
280 |
</td><td class="summary"> |
|
281 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
282 |
<tr> |
|
283 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#add_string" class="summary-sig-name">add_string</a>(<span class="summary-sig-arg">self</span>, |
|
284 |
<span class="summary-sig-arg">s</span>)</span><br /> |
|
285 |
Add a string to the stream.</td> |
|
286 |
<td align="right" valign="top"> |
|
287 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
288 |
||
289 |
</td> |
|
290 |
</tr> |
|
291 |
</table> |
|
292 |
||
293 |
</td> |
|
294 |
</tr> |
|
295 |
<tr> |
|
296 |
<td width="15%" align="right" valign="top" class="summary"> |
|
297 |
<span class="summary-type">bool</span> |
|
298 |
</td><td class="summary"> |
|
299 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
300 |
<tr> |
|
301 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#get_boolean" class="summary-sig-name">get_boolean</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
302 |
Fetch a boolean from the stream.</td> |
|
303 |
<td align="right" valign="top"> |
|
304 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
305 |
||
306 |
</td> |
|
307 |
</tr> |
|
308 |
</table> |
|
309 |
||
310 |
</td> |
|
311 |
</tr> |
|
312 |
<tr> |
|
313 |
<td width="15%" align="right" valign="top" class="summary"> |
|
314 |
<span class="summary-type">string</span> |
|
315 |
</td><td class="summary"> |
|
316 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
317 |
<tr> |
|
318 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#get_byte" class="summary-sig-name">get_byte</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
319 |
Return the next byte of the Message, without decomposing it.</td> |
|
320 |
<td align="right" valign="top"> |
|
321 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
322 |
||
323 |
</td> |
|
324 |
</tr> |
|
325 |
</table> |
|
326 |
||
327 |
</td> |
|
328 |
</tr> |
|
329 |
<tr> |
|
330 |
<td width="15%" align="right" valign="top" class="summary"> |
|
331 |
<span class="summary-type">string</span> |
|
332 |
</td><td class="summary"> |
|
333 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
334 |
<tr> |
|
335 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#get_bytes" class="summary-sig-name">get_bytes</a>(<span class="summary-sig-arg">self</span>, |
|
336 |
<span class="summary-sig-arg">n</span>)</span><br /> |
|
337 |
Return the next <code>n</code> bytes of the Message, without |
|
338 |
decomposing into an int, string, etc.</td> |
|
339 |
<td align="right" valign="top"> |
|
340 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
341 |
||
342 |
</td> |
|
343 |
</tr> |
|
344 |
</table> |
|
345 |
||
346 |
</td> |
|
347 |
</tr> |
|
348 |
<tr> |
|
349 |
<td width="15%" align="right" valign="top" class="summary"> |
|
350 |
<span class="summary-type">int</span> |
|
351 |
</td><td class="summary"> |
|
352 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
353 |
<tr> |
|
354 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#get_int" class="summary-sig-name">get_int</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
355 |
Fetch an int from the stream.</td> |
|
356 |
<td align="right" valign="top"> |
|
357 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
358 |
||
359 |
</td> |
|
360 |
</tr> |
|
361 |
</table> |
|
362 |
||
363 |
</td> |
|
364 |
</tr> |
|
365 |
<tr> |
|
366 |
<td width="15%" align="right" valign="top" class="summary"> |
|
367 |
<span class="summary-type">long</span> |
|
368 |
</td><td class="summary"> |
|
369 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
370 |
<tr> |
|
371 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#get_int64" class="summary-sig-name">get_int64</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
372 |
Fetch a 64-bit int from the stream.</td> |
|
373 |
<td align="right" valign="top"> |
|
374 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
375 |
||
376 |
</td> |
|
377 |
</tr> |
|
378 |
</table> |
|
379 |
||
380 |
</td> |
|
381 |
</tr> |
|
382 |
<tr> |
|
383 |
<td width="15%" align="right" valign="top" class="summary"> |
|
384 |
<span class="summary-type">list of strings</span> |
|
385 |
</td><td class="summary"> |
|
386 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
387 |
<tr> |
|
388 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#get_list" class="summary-sig-name">get_list</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
389 |
Fetch a list of strings from the stream.</td> |
|
390 |
<td align="right" valign="top"> |
|
391 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
392 |
||
393 |
</td> |
|
394 |
</tr> |
|
395 |
</table> |
|
396 |
||
397 |
</td> |
|
398 |
</tr> |
|
399 |
<tr> |
|
400 |
<td width="15%" align="right" valign="top" class="summary"> |
|
401 |
<span class="summary-type">long</span> |
|
402 |
</td><td class="summary"> |
|
403 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
404 |
<tr> |
|
405 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#get_mpint" class="summary-sig-name">get_mpint</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
406 |
Fetch a long int (mpint) from the stream.</td> |
|
407 |
<td align="right" valign="top"> |
|
408 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
409 |
||
410 |
</td> |
|
411 |
</tr> |
|
412 |
</table> |
|
413 |
||
414 |
</td> |
|
415 |
</tr> |
|
416 |
<tr> |
|
417 |
<td width="15%" align="right" valign="top" class="summary"> |
|
418 |
<span class="summary-type">string</span> |
|
419 |
</td><td class="summary"> |
|
420 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
421 |
<tr> |
|
422 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#get_remainder" class="summary-sig-name">get_remainder</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
423 |
Return the bytes of this Message that haven't already been parsed and |
|
424 |
returned.</td> |
|
425 |
<td align="right" valign="top"> |
|
426 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
427 |
||
428 |
</td> |
|
429 |
</tr> |
|
430 |
</table> |
|
431 |
||
432 |
</td> |
|
433 |
</tr> |
|
434 |
<tr> |
|
435 |
<td width="15%" align="right" valign="top" class="summary"> |
|
436 |
<span class="summary-type">string</span> |
|
437 |
</td><td class="summary"> |
|
438 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
439 |
<tr> |
|
440 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#get_so_far" class="summary-sig-name">get_so_far</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
441 |
Returns the bytes of this Message that have been parsed and returned.</td> |
|
442 |
<td align="right" valign="top"> |
|
443 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
444 |
||
445 |
</td> |
|
446 |
</tr> |
|
447 |
</table> |
|
448 |
||
449 |
</td> |
|
450 |
</tr> |
|
451 |
<tr> |
|
452 |
<td width="15%" align="right" valign="top" class="summary"> |
|
453 |
<span class="summary-type">string</span> |
|
454 |
</td><td class="summary"> |
|
455 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
456 |
<tr> |
|
457 |
<td><span class="summary-sig"><a href="paramiko.Message-class.html#get_string" class="summary-sig-name">get_string</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
458 |
Fetch a string from the stream.</td> |
|
459 |
<td align="right" valign="top"> |
|
460 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
461 |
||
462 |
</td> |
|
463 |
</tr> |
|
464 |
</table> |
|
465 |
||
466 |
</td> |
|
467 |
</tr> |
|
468 |
<tr> |
|
469 |
<td width="15%" align="right" valign="top" class="summary"> |
|
470 |
<span class="summary-type"> </span> |
|
471 |
</td><td class="summary"> |
|
472 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
473 |
<tr> |
|
474 |
<td><span class="summary-sig"><a name="rewind"></a><span class="summary-sig-name">rewind</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
475 |
Rewind the message to the beginning as if no items had been parsed |
|
476 |
out of it yet.</td> |
|
477 |
<td align="right" valign="top"> |
|
478 |
<span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
479 |
||
480 |
</td> |
|
481 |
</tr> |
|
482 |
</table> |
|
483 |
||
484 |
</td> |
|
485 |
</tr> |
|
486 |
<tr> |
|
487 |
<td colspan="2" class="summary"> |
|
488 |
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
489 |
<code>__delattr__</code>, |
|
|
5
by Jeremy T. Bouse
Imported Upstream version 1.7.6 |
490 |
<code>__format__</code>, |
|
2
by Jeremy T. Bouse
Imported Upstream version 1.7.4 |
491 |
<code>__getattribute__</code>, |
492 |
<code>__hash__</code>, |
|
493 |
<code>__new__</code>, |
|
494 |
<code>__reduce__</code>, |
|
495 |
<code>__reduce_ex__</code>, |
|
|
5
by Jeremy T. Bouse
Imported Upstream version 1.7.6 |
496 |
<code>__setattr__</code>, |
497 |
<code>__sizeof__</code>, |
|
498 |
<code>__subclasshook__</code> |
|
|
2
by Jeremy T. Bouse
Imported Upstream version 1.7.4 |
499 |
</p> |
500 |
</td> |
|
501 |
</tr> |
|
502 |
</table> |
|
503 |
<!-- ==================== PROPERTIES ==================== -->
|
|
504 |
<a name="section-Properties"></a> |
|
505 |
<table class="summary" border="1" cellpadding="3" |
|
506 |
cellspacing="0" width="100%" bgcolor="white"> |
|
507 |
<tr bgcolor="#70b0f0" class="table-header"> |
|
508 |
<td align="left" colspan="2" class="table-header"> |
|
509 |
<span class="table-header">Properties</span></td> |
|
510 |
</tr> |
|
511 |
<tr> |
|
512 |
<td colspan="2" class="summary"> |
|
513 |
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
514 |
<code>__class__</code> |
|
515 |
</p> |
|
516 |
</td> |
|
517 |
</tr> |
|
518 |
</table> |
|
519 |
<!-- ==================== METHOD DETAILS ==================== -->
|
|
520 |
<a name="section-MethodDetails"></a> |
|
521 |
<table class="details" border="1" cellpadding="3" |
|
522 |
cellspacing="0" width="100%" bgcolor="white"> |
|
523 |
<tr bgcolor="#70b0f0" class="table-header"> |
|
524 |
<td align="left" colspan="2" class="table-header"> |
|
525 |
<span class="table-header">Method Details</span></td> |
|
526 |
</tr> |
|
527 |
</table> |
|
528 |
<a name="__init__"></a> |
|
529 |
<div> |
|
530 |
<table class="details" border="1" cellpadding="3" |
|
531 |
cellspacing="0" width="100%" bgcolor="white"> |
|
532 |
<tr><td> |
|
533 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
534 |
<tr valign="top"><td> |
|
535 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
|
536 |
<span class="sig-arg">content</span>=<span class="sig-default">None</span>)</span> |
|
537 |
<br /><em class="fname">(Constructor)</em> |
|
538 |
</h3> |
|
539 |
</td><td align="right" valign="top" |
|
540 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
541 |
</td> |
|
542 |
</tr></table> |
|
543 |
||
544 |
<p>Create a new SSH2 Message.</p> |
|
545 |
<dl class="fields"> |
|
546 |
<dt>Parameters:</dt> |
|
547 |
<dd><ul class="nomargin-top"> |
|
548 |
<li><strong class="pname"><code>content</code></strong> (string) - the byte stream to use as the Message content (passed in only |
|
549 |
when decomposing a Message).</li> |
|
550 |
</ul></dd> |
|
551 |
<dt>Overrides: |
|
552 |
object.__init__ |
|
553 |
</dt> |
|
554 |
</dl> |
|
555 |
</td></tr></table> |
|
556 |
</div> |
|
557 |
<a name="__repr__"></a> |
|
558 |
<div> |
|
559 |
<table class="details" border="1" cellpadding="3" |
|
560 |
cellspacing="0" width="100%" bgcolor="white"> |
|
561 |
<tr><td> |
|
562 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
563 |
<tr valign="top"><td> |
|
564 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span> |
|
565 |
<br /><em class="fname">(Representation operator)</em> |
|
566 |
</h3> |
|
567 |
</td><td align="right" valign="top" |
|
568 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
569 |
</td> |
|
570 |
</tr></table> |
|
571 |
||
572 |
<p>Returns a string representation of this object, for debugging.</p> |
|
573 |
<dl class="fields"> |
|
574 |
<dt>Returns: string</dt> |
|
575 |
<dt>Overrides: |
|
576 |
object.__repr__ |
|
577 |
</dt> |
|
578 |
</dl> |
|
579 |
</td></tr></table> |
|
580 |
</div> |
|
581 |
<a name="__str__"></a> |
|
582 |
<div> |
|
583 |
<table class="details" border="1" cellpadding="3" |
|
584 |
cellspacing="0" width="100%" bgcolor="white"> |
|
585 |
<tr><td> |
|
586 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
587 |
<tr valign="top"><td> |
|
588 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span> |
|
589 |
<br /><em class="fname">(Informal representation operator)</em> |
|
590 |
</h3> |
|
591 |
</td><td align="right" valign="top" |
|
592 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
593 |
</td> |
|
594 |
</tr></table> |
|
595 |
||
596 |
<p>Return the byte stream content of this Message, as a string.</p> |
|
597 |
<dl class="fields"> |
|
598 |
<dt>Returns: string</dt> |
|
599 |
<dd>the contents of this Message.</dd> |
|
600 |
<dt>Overrides: |
|
601 |
object.__str__ |
|
602 |
</dt> |
|
603 |
</dl> |
|
604 |
</td></tr></table> |
|
605 |
</div> |
|
606 |
<a name="add"></a> |
|
607 |
<div> |
|
608 |
<table class="details" border="1" cellpadding="3" |
|
609 |
cellspacing="0" width="100%" bgcolor="white"> |
|
610 |
<tr><td> |
|
611 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
612 |
<tr valign="top"><td> |
|
613 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">add</span>(<span class="sig-arg">self</span>, |
|
614 |
<span class="sig-arg">*seq</span>)</span> |
|
615 |
</h3> |
|
616 |
</td><td align="right" valign="top" |
|
617 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
618 |
</td> |
|
619 |
</tr></table> |
|
620 |
||
621 |
<p>Add a sequence of items to the stream. The values are encoded based |
|
622 |
on their type: str, int, bool, list, or long.</p> |
|
623 |
<dl class="fields"> |
|
624 |
<dt>Parameters:</dt> |
|
625 |
<dd><ul class="nomargin-top"> |
|
626 |
<li><strong class="pname"><code>seq</code></strong> (sequence) - the sequence of items</li> |
|
627 |
</ul></dd> |
|
628 |
</dl> |
|
629 |
<div class="fields"> <p><strong>Bug:</strong> |
|
630 |
longs are encoded non-deterministically. Don't use this method. |
|
631 |
</p> |
|
632 |
</div></td></tr></table> |
|
633 |
</div> |
|
634 |
<a name="add_boolean"></a> |
|
635 |
<div> |
|
636 |
<table class="details" border="1" cellpadding="3" |
|
637 |
cellspacing="0" width="100%" bgcolor="white"> |
|
638 |
<tr><td> |
|
639 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
640 |
<tr valign="top"><td> |
|
641 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">add_boolean</span>(<span class="sig-arg">self</span>, |
|
642 |
<span class="sig-arg">b</span>)</span> |
|
643 |
</h3> |
|
644 |
</td><td align="right" valign="top" |
|
645 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
646 |
</td> |
|
647 |
</tr></table> |
|
648 |
||
649 |
<p>Add a boolean value to the stream.</p> |
|
650 |
<dl class="fields"> |
|
651 |
<dt>Parameters:</dt> |
|
652 |
<dd><ul class="nomargin-top"> |
|
653 |
<li><strong class="pname"><code>b</code></strong> (bool) - boolean value to add</li> |
|
654 |
</ul></dd> |
|
655 |
</dl> |
|
656 |
</td></tr></table> |
|
657 |
</div> |
|
658 |
<a name="add_byte"></a> |
|
659 |
<div> |
|
660 |
<table class="details" border="1" cellpadding="3" |
|
661 |
cellspacing="0" width="100%" bgcolor="white"> |
|
662 |
<tr><td> |
|
663 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
664 |
<tr valign="top"><td> |
|
665 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">add_byte</span>(<span class="sig-arg">self</span>, |
|
666 |
<span class="sig-arg">b</span>)</span> |
|
667 |
</h3> |
|
668 |
</td><td align="right" valign="top" |
|
669 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
670 |
</td> |
|
671 |
</tr></table> |
|
672 |
||
673 |
<p>Write a single byte to the stream, without any formatting.</p> |
|
674 |
<dl class="fields"> |
|
675 |
<dt>Parameters:</dt> |
|
676 |
<dd><ul class="nomargin-top"> |
|
677 |
<li><strong class="pname"><code>b</code></strong> (str) - byte to add</li> |
|
678 |
</ul></dd> |
|
679 |
</dl> |
|
680 |
</td></tr></table> |
|
681 |
</div> |
|
682 |
<a name="add_bytes"></a> |
|
683 |
<div> |
|
684 |
<table class="details" border="1" cellpadding="3" |
|
685 |
cellspacing="0" width="100%" bgcolor="white"> |
|
686 |
<tr><td> |
|
687 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
688 |
<tr valign="top"><td> |
|
689 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">add_bytes</span>(<span class="sig-arg">self</span>, |
|
690 |
<span class="sig-arg">b</span>)</span> |
|
691 |
</h3> |
|
692 |
</td><td align="right" valign="top" |
|
693 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
694 |
</td> |
|
695 |
</tr></table> |
|
696 |
||
697 |
<p>Write bytes to the stream, without any formatting.</p> |
|
698 |
<dl class="fields"> |
|
699 |
<dt>Parameters:</dt> |
|
700 |
<dd><ul class="nomargin-top"> |
|
701 |
<li><strong class="pname"><code>b</code></strong> (str) - bytes to add</li> |
|
702 |
</ul></dd> |
|
703 |
</dl> |
|
704 |
</td></tr></table> |
|
705 |
</div> |
|
706 |
<a name="add_int"></a> |
|
707 |
<div> |
|
708 |
<table class="details" border="1" cellpadding="3" |
|
709 |
cellspacing="0" width="100%" bgcolor="white"> |
|
710 |
<tr><td> |
|
711 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
712 |
<tr valign="top"><td> |
|
713 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">add_int</span>(<span class="sig-arg">self</span>, |
|
714 |
<span class="sig-arg">n</span>)</span> |
|
715 |
</h3> |
|
716 |
</td><td align="right" valign="top" |
|
717 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
718 |
</td> |
|
719 |
</tr></table> |
|
720 |
||
721 |
<p>Add an integer to the stream.</p> |
|
722 |
<dl class="fields"> |
|
723 |
<dt>Parameters:</dt> |
|
724 |
<dd><ul class="nomargin-top"> |
|
725 |
<li><strong class="pname"><code>n</code></strong> (int) - integer to add</li> |
|
726 |
</ul></dd> |
|
727 |
</dl> |
|
728 |
</td></tr></table> |
|
729 |
</div> |
|
730 |
<a name="add_int64"></a> |
|
731 |
<div> |
|
732 |
<table class="details" border="1" cellpadding="3" |
|
733 |
cellspacing="0" width="100%" bgcolor="white"> |
|
734 |
<tr><td> |
|
735 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
736 |
<tr valign="top"><td> |
|
737 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">add_int64</span>(<span class="sig-arg">self</span>, |
|
738 |
<span class="sig-arg">n</span>)</span> |
|
739 |
</h3> |
|
740 |
</td><td align="right" valign="top" |
|
741 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
742 |
</td> |
|
743 |
</tr></table> |
|
744 |
||
745 |
<p>Add a 64-bit int to the stream.</p> |
|
746 |
<dl class="fields"> |
|
747 |
<dt>Parameters:</dt> |
|
748 |
<dd><ul class="nomargin-top"> |
|
749 |
<li><strong class="pname"><code>n</code></strong> (long) - long int to add</li> |
|
750 |
</ul></dd> |
|
751 |
</dl> |
|
752 |
</td></tr></table> |
|
753 |
</div> |
|
754 |
<a name="add_list"></a> |
|
755 |
<div> |
|
756 |
<table class="details" border="1" cellpadding="3" |
|
757 |
cellspacing="0" width="100%" bgcolor="white"> |
|
758 |
<tr><td> |
|
759 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
760 |
<tr valign="top"><td> |
|
761 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">add_list</span>(<span class="sig-arg">self</span>, |
|
762 |
<span class="sig-arg">l</span>)</span> |
|
763 |
</h3> |
|
764 |
</td><td align="right" valign="top" |
|
765 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
766 |
</td> |
|
767 |
</tr></table> |
|
768 |
||
769 |
<p>Add a list of strings to the stream. They are encoded identically to |
|
770 |
a single string of values separated by commas. (Yes, really, that's how |
|
771 |
SSH2 does it.)</p> |
|
772 |
<dl class="fields"> |
|
773 |
<dt>Parameters:</dt> |
|
774 |
<dd><ul class="nomargin-top"> |
|
775 |
<li><strong class="pname"><code>l</code></strong> (list(str)) - list of strings to add</li> |
|
776 |
</ul></dd> |
|
777 |
</dl> |
|
778 |
</td></tr></table> |
|
779 |
</div> |
|
780 |
<a name="add_mpint"></a> |
|
781 |
<div> |
|
782 |
<table class="details" border="1" cellpadding="3" |
|
783 |
cellspacing="0" width="100%" bgcolor="white"> |
|
784 |
<tr><td> |
|
785 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
786 |
<tr valign="top"><td> |
|
787 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">add_mpint</span>(<span class="sig-arg">self</span>, |
|
788 |
<span class="sig-arg">z</span>)</span> |
|
789 |
</h3> |
|
790 |
</td><td align="right" valign="top" |
|
791 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
792 |
</td> |
|
793 |
</tr></table> |
|
794 |
||
795 |
<p>Add a long int to the stream, encoded as an infinite-precision |
|
796 |
integer. This method only works on positive numbers.</p> |
|
797 |
<dl class="fields"> |
|
798 |
<dt>Parameters:</dt> |
|
799 |
<dd><ul class="nomargin-top"> |
|
800 |
<li><strong class="pname"><code>z</code></strong> (long) - long int to add</li> |
|
801 |
</ul></dd> |
|
802 |
</dl> |
|
803 |
</td></tr></table> |
|
804 |
</div> |
|
805 |
<a name="add_string"></a> |
|
806 |
<div> |
|
807 |
<table class="details" border="1" cellpadding="3" |
|
808 |
cellspacing="0" width="100%" bgcolor="white"> |
|
809 |
<tr><td> |
|
810 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
811 |
<tr valign="top"><td> |
|
812 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">add_string</span>(<span class="sig-arg">self</span>, |
|
813 |
<span class="sig-arg">s</span>)</span> |
|
814 |
</h3> |
|
815 |
</td><td align="right" valign="top" |
|
816 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
817 |
</td> |
|
818 |
</tr></table> |
|
819 |
||
820 |
<p>Add a string to the stream.</p> |
|
821 |
<dl class="fields"> |
|
822 |
<dt>Parameters:</dt> |
|
823 |
<dd><ul class="nomargin-top"> |
|
824 |
<li><strong class="pname"><code>s</code></strong> (str) - string to add</li> |
|
825 |
</ul></dd> |
|
826 |
</dl> |
|
827 |
</td></tr></table> |
|
828 |
</div> |
|
829 |
<a name="get_boolean"></a> |
|
830 |
<div> |
|
831 |
<table class="details" border="1" cellpadding="3" |
|
832 |
cellspacing="0" width="100%" bgcolor="white"> |
|
833 |
<tr><td> |
|
834 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
835 |
<tr valign="top"><td> |
|
836 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_boolean</span>(<span class="sig-arg">self</span>)</span> |
|
837 |
</h3> |
|
838 |
</td><td align="right" valign="top" |
|
839 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
840 |
</td> |
|
841 |
</tr></table> |
|
842 |
||
843 |
<p>Fetch a boolean from the stream.</p> |
|
844 |
<dl class="fields"> |
|
845 |
<dt>Returns: bool</dt> |
|
846 |
<dd><code>True</code> or <code>False</code> (from the Message).</dd> |
|
847 |
</dl> |
|
848 |
</td></tr></table> |
|
849 |
</div> |
|
850 |
<a name="get_byte"></a> |
|
851 |
<div> |
|
852 |
<table class="details" border="1" cellpadding="3" |
|
853 |
cellspacing="0" width="100%" bgcolor="white"> |
|
854 |
<tr><td> |
|
855 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
856 |
<tr valign="top"><td> |
|
857 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_byte</span>(<span class="sig-arg">self</span>)</span> |
|
858 |
</h3> |
|
859 |
</td><td align="right" valign="top" |
|
860 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
861 |
</td> |
|
862 |
</tr></table> |
|
863 |
||
864 |
<p>Return the next byte of the Message, without decomposing it. This is |
|
865 |
equivalent to <a href="paramiko.Message-class.html#get_bytes" |
|
866 |
class="link">get_bytes(1)</a>.</p> |
|
867 |
<dl class="fields"> |
|
868 |
<dt>Returns: string</dt> |
|
869 |
<dd>the next byte of the Message, or <code>' '</code> if there aren't |
|
870 |
any bytes remaining.</dd> |
|
871 |
</dl> |
|
872 |
</td></tr></table> |
|
873 |
</div> |
|
874 |
<a name="get_bytes"></a> |
|
875 |
<div> |
|
876 |
<table class="details" border="1" cellpadding="3" |
|
877 |
cellspacing="0" width="100%" bgcolor="white"> |
|
878 |
<tr><td> |
|
879 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
880 |
<tr valign="top"><td> |
|
881 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_bytes</span>(<span class="sig-arg">self</span>, |
|
882 |
<span class="sig-arg">n</span>)</span> |
|
883 |
</h3> |
|
884 |
</td><td align="right" valign="top" |
|
885 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
886 |
</td> |
|
887 |
</tr></table> |
|
888 |
||
889 |
<p>Return the next <code>n</code> bytes of the Message, without |
|
890 |
decomposing into an int, string, etc. Just the raw bytes are |
|
891 |
returned.</p> |
|
892 |
<dl class="fields"> |
|
893 |
<dt>Returns: string</dt> |
|
894 |
<dd>a string of the next <code>n</code> bytes of the Message, or a |
|
895 |
string of <code>n</code> zero bytes, if there aren't |
|
896 |
<code>n</code> bytes remaining.</dd> |
|
897 |
</dl> |
|
898 |
</td></tr></table> |
|
899 |
</div> |
|
900 |
<a name="get_int"></a> |
|
901 |
<div> |
|
902 |
<table class="details" border="1" cellpadding="3" |
|
903 |
cellspacing="0" width="100%" bgcolor="white"> |
|
904 |
<tr><td> |
|
905 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
906 |
<tr valign="top"><td> |
|
907 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_int</span>(<span class="sig-arg">self</span>)</span> |
|
908 |
</h3> |
|
909 |
</td><td align="right" valign="top" |
|
910 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
911 |
</td> |
|
912 |
</tr></table> |
|
913 |
||
914 |
<p>Fetch an int from the stream.</p> |
|
915 |
<dl class="fields"> |
|
916 |
<dt>Returns: int</dt> |
|
917 |
<dd>a 32-bit unsigned integer.</dd> |
|
918 |
</dl> |
|
919 |
</td></tr></table> |
|
920 |
</div> |
|
921 |
<a name="get_int64"></a> |
|
922 |
<div> |
|
923 |
<table class="details" border="1" cellpadding="3" |
|
924 |
cellspacing="0" width="100%" bgcolor="white"> |
|
925 |
<tr><td> |
|
926 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
927 |
<tr valign="top"><td> |
|
928 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_int64</span>(<span class="sig-arg">self</span>)</span> |
|
929 |
</h3> |
|
930 |
</td><td align="right" valign="top" |
|
931 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
932 |
</td> |
|
933 |
</tr></table> |
|
934 |
||
935 |
<p>Fetch a 64-bit int from the stream.</p> |
|
936 |
<dl class="fields"> |
|
937 |
<dt>Returns: long</dt> |
|
938 |
<dd>a 64-bit unsigned integer.</dd> |
|
939 |
</dl> |
|
940 |
</td></tr></table> |
|
941 |
</div> |
|
942 |
<a name="get_list"></a> |
|
943 |
<div> |
|
944 |
<table class="details" border="1" cellpadding="3" |
|
945 |
cellspacing="0" width="100%" bgcolor="white"> |
|
946 |
<tr><td> |
|
947 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
948 |
<tr valign="top"><td> |
|
949 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_list</span>(<span class="sig-arg">self</span>)</span> |
|
950 |
</h3> |
|
951 |
</td><td align="right" valign="top" |
|
952 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
953 |
</td> |
|
954 |
</tr></table> |
|
955 |
||
956 |
<p>Fetch a list of strings from the stream. These are trivially encoded |
|
957 |
as comma-separated values in a string.</p> |
|
958 |
<dl class="fields"> |
|
959 |
<dt>Returns: list of strings</dt> |
|
960 |
<dd>a list of strings.</dd> |
|
961 |
</dl> |
|
962 |
</td></tr></table> |
|
963 |
</div> |
|
964 |
<a name="get_mpint"></a> |
|
965 |
<div> |
|
966 |
<table class="details" border="1" cellpadding="3" |
|
967 |
cellspacing="0" width="100%" bgcolor="white"> |
|
968 |
<tr><td> |
|
969 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
970 |
<tr valign="top"><td> |
|
971 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_mpint</span>(<span class="sig-arg">self</span>)</span> |
|
972 |
</h3> |
|
973 |
</td><td align="right" valign="top" |
|
974 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
975 |
</td> |
|
976 |
</tr></table> |
|
977 |
||
978 |
<p>Fetch a long int (mpint) from the stream.</p> |
|
979 |
<dl class="fields"> |
|
980 |
<dt>Returns: long</dt> |
|
981 |
<dd>an arbitrary-length integer.</dd> |
|
982 |
</dl> |
|
983 |
</td></tr></table> |
|
984 |
</div> |
|
985 |
<a name="get_remainder"></a> |
|
986 |
<div> |
|
987 |
<table class="details" border="1" cellpadding="3" |
|
988 |
cellspacing="0" width="100%" bgcolor="white"> |
|
989 |
<tr><td> |
|
990 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
991 |
<tr valign="top"><td> |
|
992 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_remainder</span>(<span class="sig-arg">self</span>)</span> |
|
993 |
</h3> |
|
994 |
</td><td align="right" valign="top" |
|
995 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
996 |
</td> |
|
997 |
</tr></table> |
|
998 |
||
999 |
<p>Return the bytes of this Message that haven't already been parsed and |
|
1000 |
returned.</p> |
|
1001 |
<dl class="fields"> |
|
1002 |
<dt>Returns: string</dt> |
|
1003 |
<dd>a string of the bytes not parsed yet.</dd> |
|
1004 |
</dl> |
|
1005 |
</td></tr></table> |
|
1006 |
</div> |
|
1007 |
<a name="get_so_far"></a> |
|
1008 |
<div> |
|
1009 |
<table class="details" border="1" cellpadding="3" |
|
1010 |
cellspacing="0" width="100%" bgcolor="white"> |
|
1011 |
<tr><td> |
|
1012 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
1013 |
<tr valign="top"><td> |
|
1014 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_so_far</span>(<span class="sig-arg">self</span>)</span> |
|
1015 |
</h3> |
|
1016 |
</td><td align="right" valign="top" |
|
1017 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
1018 |
</td> |
|
1019 |
</tr></table> |
|
1020 |
||
1021 |
<p>Returns the bytes of this Message that have been parsed and returned. |
|
1022 |
The string passed into a Message's constructor can be regenerated by |
|
1023 |
concatenating <code>get_so_far</code> and <a |
|
1024 |
href="paramiko.Message-class.html#get_remainder" |
|
1025 |
class="link">get_remainder</a>.</p> |
|
1026 |
<dl class="fields"> |
|
1027 |
<dt>Returns: string</dt> |
|
1028 |
<dd>a string of the bytes parsed so far.</dd> |
|
1029 |
</dl> |
|
1030 |
</td></tr></table> |
|
1031 |
</div> |
|
1032 |
<a name="get_string"></a> |
|
1033 |
<div> |
|
1034 |
<table class="details" border="1" cellpadding="3" |
|
1035 |
cellspacing="0" width="100%" bgcolor="white"> |
|
1036 |
<tr><td> |
|
1037 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
1038 |
<tr valign="top"><td> |
|
1039 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_string</span>(<span class="sig-arg">self</span>)</span> |
|
1040 |
</h3> |
|
1041 |
</td><td align="right" valign="top" |
|
1042 |
><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> |
|
1043 |
</td> |
|
1044 |
</tr></table> |
|
1045 |
||
1046 |
<p>Fetch a string from the stream. This could be a byte string and may |
|
1047 |
contain unprintable characters. (It's not unheard of for a string to |
|
1048 |
contain another byte-stream Message.)</p> |
|
1049 |
<dl class="fields"> |
|
1050 |
<dt>Returns: string</dt> |
|
1051 |
<dd>a string.</dd> |
|
1052 |
</dl> |
|
1053 |
</td></tr></table> |
|
1054 |
</div> |
|
1055 |
<br /> |
|
1056 |
<!-- ==================== NAVIGATION BAR ==================== -->
|
|
1057 |
<table class="navbar" border="0" width="100%" cellpadding="0" |
|
1058 |
bgcolor="#a0c0ff" cellspacing="0"> |
|
1059 |
<tr valign="middle"> |
|
1060 |
<!-- Home link -->
|
|
1061 |
<th> <a |
|
1062 |
href="paramiko-module.html">Home</a> </th> |
|
1063 |
||
1064 |
<!-- Tree link -->
|
|
1065 |
<th> <a |
|
1066 |
href="module-tree.html">Trees</a> </th> |
|
1067 |
||
1068 |
<!-- Index link -->
|
|
1069 |
<th> <a |
|
1070 |
href="identifier-index.html">Indices</a> </th> |
|
1071 |
||
1072 |
<!-- Help link -->
|
|
1073 |
<th> <a |
|
1074 |
href="help.html">Help</a> </th> |
|
1075 |
||
1076 |
<th class="navbar" width="100%"></th> |
|
1077 |
</tr> |
|
1078 |
</table> |
|
1079 |
<table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
1080 |
<tr> |
|
1081 |
<td align="left" class="footer"> |
|
|
5
by Jeremy T. Bouse
Imported Upstream version 1.7.6 |
1082 |
Generated by Epydoc 3.0.1 on Sun Nov 1 22:14:16 2009 |
|
2
by Jeremy T. Bouse
Imported Upstream version 1.7.4 |
1083 |
</td> |
1084 |
<td align="right" class="footer"> |
|
1085 |
<a target="mainFrame" href="http://epydoc.sourceforge.net" |
|
1086 |
>http://epydoc.sourceforge.net</a> |
|
1087 |
</td> |
|
1088 |
</tr> |
|
1089 |
</table> |
|
1090 |
||
1091 |
<script type="text/javascript"> |
|
1092 |
<!--
|
|
1093 |
// Private objects are initially displayed (because if
|
|
1094 |
// javascript is turned off then we want them to be
|
|
1095 |
// visible); but by default, we want to hide them. So hide
|
|
1096 |
// them unless we have a cookie that says to show them.
|
|
1097 |
checkCookie(); |
|
1098 |
// -->
|
|
1099 |
</script> |
|
1100 |
</body> |
|
1101 |
</html> |