From 176c6caf4ea7918e1698438634b237fab8456471 Mon Sep 17 00:00:00 2001 From: "Jeremy T. Bouse" Date: Fri, 27 Nov 2009 16:20:09 -0500 Subject: Imported Upstream version 1.5.2 --- docs/private/paramiko.Packetizer-class.html | 441 ++++++++++++++++++++++++++++ 1 file changed, 441 insertions(+) create mode 100644 docs/private/paramiko.Packetizer-class.html (limited to 'docs/private/paramiko.Packetizer-class.html') diff --git a/docs/private/paramiko.Packetizer-class.html b/docs/private/paramiko.Packetizer-class.html new file mode 100644 index 0000000..f3be97b --- /dev/null +++ b/docs/private/paramiko.Packetizer-class.html @@ -0,0 +1,441 @@ + + + + + paramiko.Packetizer + + + + + + + + + + + + + +
   Home      Trees      Index      Help   
+ + + + +
+ + Package paramiko :: + Class Packetizer +
+ 		+ + +
[show private | hide private]
[frames | no frames]
+ + +

Type Packetizer

+ +
+object --+
+         |
+        Packetizer
+

+ +
+ +Implementation of the base SSH packet protocol. +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method Summary
 __init__(self, + socket) +
 __del__(self) +
 _build_packet(self, + payload) +
 _check_keepalive(self) +
 _log(self, + level, + msg) +
 _py22_read_all(self, + n) +
 _py22_read_timeout(self, + timeout) +
 _read_timeout(self, + timeout) +
 _trigger_rekey(self) +
 close(self) +
 get_hexdump(self) +
 get_mac_size_in(self) +
 get_mac_size_out(self) +
 need_rekey(self) +
+Returns True if a new set of keys needs to be +negotiated.
str +read_all(self, + n, + check_rekey) +
+Read as close to N bytes as possible, blocking as long as +necessary.
 read_message(self) +
+Only one thread should ever be in this function (no other locking is +done).
 readline(self, + timeout) +
+Read a line from the socket.
 send_message(self, + data) +
+Write a block of data using the current cipher, as an SSH block.
 set_hexdump(self, + hexdump) +
 set_inbound_cipher(self, + block_engine, + block_size, + mac_engine, + mac_size, + mac_key) +
+Switch inbound data cipher.
 set_inbound_compressor(self, + compressor) +
 set_keepalive(self, + interval, + callback) +
+Turn on/off the callback keepalive.
 set_log(self, + log) +
+Set the python log object to use for logging.
 set_outbound_cipher(self, + block_engine, + block_size, + mac_engine, + mac_size, + mac_key) +
+Switch outbound data cipher.
 set_outbound_compressor(self, + compressor) +
 write_all(self, + out) +
    Inherited from object
 __delattr__(...) +
+x.__delattr__('name') <==> del x.name
 __getattribute__(...) +
+x.__getattribute__('name') <==> x.name
 __hash__(x) +
+x.__hash__() <==> hash(x)
 __new__(T, + S, + ...) +
+T.__new__(S, ...) -> a new object with type S, a subtype of T
 __reduce__(...) +
+helper for pickle
 __reduce_ex__(...) +
+helper for pickle
 __repr__(x) +
+x.__repr__() <==> repr(x)
 __setattr__(...) +
+x.__setattr__('name', value) <==> x.name = value
 __str__(x) +
+x.__str__() <==> str(x)

+ + + + + + + + + + +
Class Variable Summary
intREKEY_BYTES = 1073741824                                                            
intREKEY_PACKETS = 1073741824                                                            

+ + + + + + +
Method Details
+ + +
+

need_rekey(self) +

+ Returns True if a new set of keys needs to be + negotiated. This will be triggered during a packet read or write, so it + should be checked after every read or write, or at least after every + few. +
+
Returns:
+
+ True if a new set of keys needs to be + negotiated +
+
+
+
+ + +
+

read_all(self, + n, + check_rekey=False) +

+ Read as close to N bytes as possible, blocking as long as + necessary. +
+
Parameters:
+
n - + number of bytes to read +
           + (type=int) +
+
+
Returns:
+
+ the data read +
           + (type=str) +
+
+
Raises:
+
EOFError - + if the socket was closed before all the bytes could be + read +
+
+
+ + +
+

read_message(self) +

+ Only one thread should ever be in this function (no other locking is + done). +
+
Raises:
+
SSHException - + if the packet is mangled +
NeedRekeyException - + if the transport should rekey +
+
+
+ + +
+

readline(self, + timeout) +

+ Read a line from the socket. This is done in a fairly inefficient + way, but is only used for initial banner negotiation so it's not worth + optimising. +
+
+
+ + +
+

send_message(self, + data) +

+ Write a block of data using the current cipher, as an SSH block. +
+
+
+ + +
+

set_inbound_cipher(self, + block_engine, + block_size, + mac_engine, + mac_size, + mac_key) +

+ Switch inbound data cipher. +
+
+
+ + +
+

set_keepalive(self, + interval, + callback) +

+ Turn on/off the callback keepalive. If interval seconds + pass with no data read from or written to the socket, the callback will + be executed and the timer will be reset. +
+
+
+ + +
+

set_log(self, + log) +

+ Set the python log object to use for logging. +
+
+
+ + +
+

set_outbound_cipher(self, + block_engine, + block_size, + mac_engine, + mac_size, + mac_key) +

+ Switch outbound data cipher. +
+
+
+
+ + + + + + +
Class Variable Details
+
+ +

REKEY_BYTES

+
+
+
+
+
Type:
+
+ int + +
+
Value:
+
+
+1073741824                                                            
+
+
+
+
+
+ +

REKEY_PACKETS

+
+
+
+
+
Type:
+
+ int + +
+
Value:
+
+
+1073741824                                                            
+
+
+
+
+
+ + + + + + + + + + + +
   Home      Trees      Index      Help   
+ + + + + + +
Generated by Epydoc 2.1 on Sun Dec 4 11:16:46 2005http://epydoc.sf.net
+ + -- cgit v1.2.3