[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-6]

notes about the exported api
just wrote some quick notes (for a few of the classes) about which
methods are intended to be the exported API.  python has no decent
way of distinguishing private vs public.
This commit is contained in:
Robey Pointer 2003-11-09 21:16:35 +00:00
parent 5a48714394
commit 0e1ef2c65c
1 changed files with 58 additions and 0 deletions

58
NOTES
View File

@ -11,3 +11,61 @@
SIS <-- @ --> (parse, find chan) --> secsh chan: buffer <-- SSHInputStream SIS <-- @ --> (parse, find chan) --> secsh chan: buffer <-- SSHInputStream
SSHOutputStream --> secsh chan --> secsh transport --> SOS [no thread] SSHOutputStream --> secsh chan --> secsh transport --> SOS [no thread]
exported API...
from BaseTransport:
start_client
start_server
add_server_key
get_server_key
close
get_remote_server_key
is_active
is_authenticated
open_session
open_channel
renegotiate_keys
check_channel_request
from Transport:
auth_key
auth_password
get_allowed_auths
check_auth_none
check_auth_password
check_auth_publickey
accept
from Channel:
set_name
get_name
send_eof
settimeout
gettimeout
setblocking
close
recv
send
sendall
makefile
fileno
shutdown
[client:]
get_pty
invoke_shell
exec_command
invoke_subsystem
resize_pty
from ChannelFile:
next
write
writelines
flush
read
readline
readlines
xreadlines
close