summaryrefslogtreecommitdiff
path: root/NOTES
diff options
context:
space:
mode:
authorRobey Pointer <robey@lag.net>2003-11-09 21:16:35 +0000
committerRobey Pointer <robey@lag.net>2003-11-09 21:16:35 +0000
commit0e1ef2c65c80bd76eb62f5dfd953cb987d36ce3a (patch)
treeccb2208540039ffbb552947f568bc7fff056cf99 /NOTES
parent5a4871439498fdd0cb8ea391852fc604470b2668 (diff)
downloadparamiko-0e1ef2c65c80bd76eb62f5dfd953cb987d36ce3a.tar.gz
[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.
Diffstat (limited to 'NOTES')
-rw-r--r--NOTES58
1 files changed, 58 insertions, 0 deletions
diff --git a/NOTES b/NOTES
index 9e8ce06e..e722b140 100644
--- a/NOTES
+++ b/NOTES
@@ -11,3 +11,61 @@
SIS <-- @ --> (parse, find chan) --> secsh chan: buffer <-- SSHInputStream
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