From b2d0d13a2d6709c740453ee3ff32bc37160cc331 Mon Sep 17 00:00:00 2001 From: Jean-Philippe Garcia Ballester Date: Sun, 9 Jul 2006 10:36:44 +0000 Subject: Add ssh_finalize to handle finalization of libssh and underlying cryptographic library. Add corresponding paragraph in API draft. git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@75 7dcaeef0-15fb-0310-b436-a5af3365683c --- doc/libssh-0.2-api-1.txt | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'doc') diff --git a/doc/libssh-0.2-api-1.txt b/doc/libssh-0.2-api-1.txt index ff35b39..22d08e5 100644 --- a/doc/libssh-0.2-api-1.txt +++ b/doc/libssh-0.2-api-1.txt @@ -48,6 +48,19 @@ things that each kind of object must do. B. Description of objects and functions +Initialization and finalization +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Initialization is for now called automatically, so you don't have to take care +of that. +As for finalization, we need to finalize the underlying cryptographic library +(either OpenSSL or libgcrypt). Be sure that you call ssh_finalize when this +library won't be used anymore, even by other libraries (i.e. if you use libssh +and another library that uses OpenSSL, call ssh_finalize when any function of +both these libraries won't be called). +If you trust your operating system to clean up the mess after a process +terminates, you can skip this call. + Options structure ~~~~~~~~~~~~~~~~~ @@ -351,6 +364,8 @@ channel functions will run. C. Change log of this document +3. Add paragraph about initalization and finalization. + 2. ssh_options_set_username finaly is kept into the options, because it can be set by ssh_options_getopt() -- cgit v1.2.3