1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>paramiko.Message</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="paramiko-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="paramiko-module.html">Package paramiko</a> ::
Class Message
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.Message-class.html">hide private</a>]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.Message-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Type Message</h2>
<pre class="base-tree">
<a href="__builtin__.object-class.html"><code>object</code></a> --+
|
<b>Message</b>
</pre><br />
<hr/>
<p>An SSH2 <i>Message</i> is a stream of bytes that encodes some
combination of strings, integers, bools, and infinite-precision integers
(known in python as <i>long</i>s). This class builds or breaks down such
a byte stream.</p>
Normally you don't need to deal with anything this low-level, but it's
exposed for people implementing custom extensions, or features that
paramiko doesn't support yet.
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>content</span>)</span></code>
<br />
Create a new SSH2 Message.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> string
</font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Returns a string representation of this object, for debugging.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> string
</font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the byte stream content of this Message, as a string.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add" class="summary-sig-name"><code>add</code></a>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-vararg">*seq</span>)</span></code>
<br />
Add a sequence of items to the stream.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_boolean" class="summary-sig-name"><code>add_boolean</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>b</span>)</span></code>
<br />
Add a boolean value to the stream.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_byte" class="summary-sig-name"><code>add_byte</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>b</span>)</span></code>
<br />
Write a single byte to the stream, without any formatting.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_bytes" class="summary-sig-name"><code>add_bytes</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>b</span>)</span></code>
<br />
Write bytes to the stream, without any formatting.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_int" class="summary-sig-name"><code>add_int</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>n</span>)</span></code>
<br />
Add an integer to the stream.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_int64" class="summary-sig-name"><code>add_int64</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>n</span>)</span></code>
<br />
Add a 64-bit int to the stream.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_list" class="summary-sig-name"><code>add_list</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>l</span>)</span></code>
<br />
Add a list of strings to the stream.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_mpint" class="summary-sig-name"><code>add_mpint</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>z</span>)</span></code>
<br />
Add a long int to the stream, encoded as an infinite-precision
integer.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_string" class="summary-sig-name"><code>add_string</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>s</span>)</span></code>
<br />
Add a string to the stream.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> bool
</font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_boolean" class="summary-sig-name"><code>get_boolean</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Fetch a boolean from the stream.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> string
</font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_byte" class="summary-sig-name"><code>get_byte</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the next byte of the Message, without decomposing it.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> string
</font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_bytes" class="summary-sig-name"><code>get_bytes</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>n</span>)</span></code>
<br />
Return the next <code>n</code> bytes of the Message, without
decomposing into an int, string, etc.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> int
</font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_int" class="summary-sig-name"><code>get_int</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Fetch an int from the stream.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> long
</font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_int64" class="summary-sig-name"><code>get_int64</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Fetch a 64-bit int from the stream.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> list of strings
</font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_list" class="summary-sig-name"><code>get_list</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Fetch a list of strings from the stream.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> long
</font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_mpint" class="summary-sig-name"><code>get_mpint</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Fetch a long int (mpint) from the stream.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> string
</font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_remainder" class="summary-sig-name"><code>get_remainder</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the bytes of this Message that haven't already been parsed and
returned.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> string
</font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_so_far" class="summary-sig-name"><code>get_so_far</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Returns the bytes of this Message that have been parsed and
returned.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> string
</font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_string" class="summary-sig-name"><code>get_string</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Fetch a string from the stream.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="paramiko.Message-class.html#rewind" class="summary-sig-name"><code>rewind</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Rewind the message to the beginning as if no items had been parsed out
of it yet.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_add"></a><span class="summary-sig"><span class="summary-sig-name">_add</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>i</span>)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from object</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
x.__delattr__('name') <==> del x.name</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
x.__getattribute__('name') <==> x.name</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
<br />
x.__hash__() <==> hash(x)</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>,
<span class=summary-sig-arg>S</span>,
<span class="summary-sig-vararg">...</span>)</span></code>
<br />
T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
helper for pickle</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
helper for pickle</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
x.__setattr__('name', value) <==> x.name = value</td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>content</span>=<span class=sig-default>None</span>)</span>
<br /><i>(Constructor)</i>
</h3>
Create a new SSH2 Message.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>content</b></code> -
the byte stream to use as the Message content (passed in only
when decomposing a Message).
<br /><i>
(type=string)</i>
</dd>
</dl>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="__repr__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__repr__</span>(<span class=sig-arg>self</span>)</span>
<br /><i>(Representation operator)</i>
</h3>
Returns a string representation of this object, for debugging.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
string
</dd>
</dl>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="__builtin__.object-class.html#__repr__"><code>__builtin__.object.__repr__</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="__str__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__str__</span>(<span class=sig-arg>self</span>)</span>
<br /><i>(Informal representation operator)</i>
</h3>
Return the byte stream content of this Message, as a string.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
the contents of this Message.
<br /><i>
(type=string)</i>
</dd>
</dl>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="__builtin__.object-class.html#__str__"><code>__builtin__.object.__str__</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="add"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">add</span>(<span class=sig-arg>self</span>,
<span class="sig-vararg">*seq</span>)</span>
</h3>
Add a sequence of items to the stream. The values are encoded based
on their type: str, int, bool, list, or long.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>seq</b></code> -
the sequence of items
<br /><i>
(type=sequence)</i>
</dd>
</dl>
<p><b>Bug:</b> longs are encoded non-deterministically. Don't use this method.
</p>
</dd></dl>
</td></tr></table>
<a name="add_boolean"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">add_boolean</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>b</span>)</span>
</h3>
Add a boolean value to the stream.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>b</b></code> -
boolean value to add
<br /><i>
(type=bool)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="add_byte"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">add_byte</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>b</span>)</span>
</h3>
Write a single byte to the stream, without any formatting.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>b</b></code> -
byte to add
<br /><i>
(type=str)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="add_bytes"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">add_bytes</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>b</span>)</span>
</h3>
Write bytes to the stream, without any formatting.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>b</b></code> -
bytes to add
<br /><i>
(type=str)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="add_int"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">add_int</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>n</span>)</span>
</h3>
Add an integer to the stream.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>n</b></code> -
integer to add
<br /><i>
(type=int)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="add_int64"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">add_int64</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>n</span>)</span>
</h3>
Add a 64-bit int to the stream.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>n</b></code> -
long int to add
<br /><i>
(type=long)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="add_list"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">add_list</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>l</span>)</span>
</h3>
Add a list of strings to the stream. They are encoded identically to
a single string of values separated by commas. (Yes, really, that's how
SSH2 does it.)
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>l</b></code> -
list of strings to add
<br /><i>
(type=list(str))</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="add_mpint"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">add_mpint</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>z</span>)</span>
</h3>
Add a long int to the stream, encoded as an infinite-precision
integer. This method only works on positive numbers.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>z</b></code> -
long int to add
<br /><i>
(type=long)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="add_string"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">add_string</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>s</span>)</span>
</h3>
Add a string to the stream.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>s</b></code> -
string to add
<br /><i>
(type=str)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="get_boolean"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get_boolean</span>(<span class=sig-arg>self</span>)</span>
</h3>
Fetch a boolean from the stream.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>True</code> or <code>False</code> (from the
Message).
<br /><i>
(type=bool)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="get_byte"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get_byte</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return the next byte of the Message, without decomposing it. This is
equivalent to <a href="paramiko.Message-class.html#get_bytes"
class="link"><code>get_bytes(1)</code></a>.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
the next byte of the Message, or <code>' '</code> if there
aren't any bytes remaining.
<br /><i>
(type=string)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="get_bytes"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get_bytes</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>n</span>)</span>
</h3>
Return the next <code>n</code> bytes of the Message, without
decomposing into an int, string, etc. Just the raw bytes are
returned.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
a string of the next <code>n</code> bytes of the Message, or a
string of <code>n</code> zero bytes, if there aren't
<code>n</code> bytes remaining.
<br /><i>
(type=string)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="get_int"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get_int</span>(<span class=sig-arg>self</span>)</span>
</h3>
Fetch an int from the stream.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
a 32-bit unsigned integer.
<br /><i>
(type=int)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="get_int64"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get_int64</span>(<span class=sig-arg>self</span>)</span>
</h3>
Fetch a 64-bit int from the stream.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
a 64-bit unsigned integer.
<br /><i>
(type=long)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="get_list"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get_list</span>(<span class=sig-arg>self</span>)</span>
</h3>
Fetch a list of strings from the stream. These are trivially encoded
as comma-separated values in a string.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
a list of strings.
<br /><i>
(type=list of strings)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="get_mpint"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get_mpint</span>(<span class=sig-arg>self</span>)</span>
</h3>
Fetch a long int (mpint) from the stream.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
an arbitrary-length integer.
<br /><i>
(type=long)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="get_remainder"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get_remainder</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return the bytes of this Message that haven't already been parsed
and returned.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
a string of the bytes not parsed yet.
<br /><i>
(type=string)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="get_so_far"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get_so_far</span>(<span class=sig-arg>self</span>)</span>
</h3>
Returns the bytes of this Message that have been parsed and
returned. The string passed into a Message's constructor can be
regenerated by concatenating <code>get_so_far</code> and <a
href="paramiko.Message-class.html#get_remainder"
class="link"><code>get_remainder</code></a>.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
a string of the bytes parsed so far.
<br /><i>
(type=string)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="get_string"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get_string</span>(<span class=sig-arg>self</span>)</span>
</h3>
Fetch a string from the stream. This could be a byte string and may
contain unprintable characters. (It's not unheard of for a string to
contain another byte-stream Message.)
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
a string.
<br /><i>
(type=string)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="rewind"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">rewind</span>(<span class=sig-arg>self</span>)</span>
</h3>
Rewind the message to the beginning as if no items had been parsed
out of it yet.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="paramiko-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:46 2005</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>
|