ssh2/TODO

Things TODO
===========

* make sure the windowing code adapts better to slow situations so that it
  doesn't then use as much memory as today. Possibly by an app-controllable
  "Window mode"?

* Introduce a function that can free data that is returned allocated from the
  lib, like when libssh2_session_last_error() is asked to return the string
  with 'want_buf' set to non-zero.

* Provide a libssh2_scp_send() API for files larger than 4GB (32bit size)

* Add more info to the man pages.

* Decrease the number of mallocs. Everywhere.

* Use SO_NOSIGPIPE for Mac OS/BSD systems where MSG_NOSIGNAL doesn't exist/work

* Extend the test suite to actually test lots of aspects of libssh2

* Fix all compiler warnings (some can't be done without API changes)

* Expose error messages sent by the server

At next SONAME bump
===================

* stop using #defined macros as part of the official API. The macros should
  either be turned into real functions or discarded from the API.

* fix the parts of the API where object pointers and function pointers are
  mixed like libssh2_session_callback_set()

* remove the following functions from the API/ABI

  libssh2_base64_decode()
  libssh2_session_flag()
  libssh2_channel_handle_extended_data()
  libssh2_channel_receive_window_adjust()
  libssh2_poll()
  libssh2_poll_channel_read()

* Rename a few function:

  libssh2_hostkey_hash => libssh2_session_hostkey_hash
  libssh2_banner_set => libssh2_session_banner_set

* change 'int' to 'libssh2_socket_t' in the public API for sockets.
Added 'TODO' file (again) with some fresh things I could think of right now 2008-12-26 07:54:08 +00:00			`Things TODO`
			`===========`

added two new issues to fix: socket type and better windowing * make sure the windowing code adapts better to slow situations so that it doesn't then use as much memory as today * Introduce a 'libssh2_socket_t' type for sockets in internal code 2009-07-27 23:58:06 +02:00			`* make sure the windowing code adapts better to slow situations so that it`
libssh2_socket_t is done, a library-free function is needed 2010-02-21 19:20:07 +01:00			`doesn't then use as much memory as today. Possibly by an app-controllable`
			`"Window mode"?`
added two new issues to fix: socket type and better windowing * make sure the windowing code adapts better to slow situations so that it doesn't then use as much memory as today * Introduce a 'libssh2_socket_t' type for sockets in internal code 2009-07-27 23:58:06 +02:00
libssh2_socket_t is done, a library-free function is needed 2010-02-21 19:20:07 +01:00			`* Introduce a function that can free data that is returned allocated from the`
			`lib, like when libssh2_session_last_error() is asked to return the string`
			`with 'want_buf' set to non-zero.`
added two new issues to fix: socket type and better windowing * make sure the windowing code adapts better to slow situations so that it doesn't then use as much memory as today * Introduce a 'libssh2_socket_t' type for sockets in internal code 2009-07-27 23:58:06 +02:00
Provide a libssh2_scp_send() API for files larger than 4GB (32bit size) 2009-06-08 16:10:37 +02:00			`* Provide a libssh2_scp_send() API for files larger than 4GB (32bit size)`

edited 2009-04-14 21:43:39 +00:00			`* Add more info to the man pages.`
Added 'TODO' file (again) with some fresh things I could think of right now 2008-12-26 07:54:08 +00:00
			`* Decrease the number of mallocs. Everywhere.`

			`* Use SO_NOSIGPIPE for Mac OS/BSD systems where MSG_NOSIGNAL doesn't exist/work`

			`* Extend the test suite to actually test lots of aspects of libssh2`

edited 2009-04-14 21:43:39 +00:00			`* Fix all compiler warnings (some can't be done without API changes)`
Added 'TODO' file (again) with some fresh things I could think of right now 2008-12-26 07:54:08 +00:00
Add TODO: Expose error messages sent by the server 2009-12-24 00:11:40 +01:00			`* Expose error messages sent by the server`

Added 'TODO' file (again) with some fresh things I could think of right now 2008-12-26 07:54:08 +00:00			`At next SONAME bump`
			`===================`

I want to remove all those macros from the official API at next soname bump 2009-01-01 22:52:46 +00:00			`* stop using #defined macros as part of the official API. The macros should`
			`either be turned into real functions or discarded from the API.`

edited 2009-04-14 21:43:39 +00:00			`* fix the parts of the API where object pointers and function pointers are`
			`mixed like libssh2_session_callback_set()`

* Renamed the functions in src/transport.c to be _libssh2_transport_ prefixed and introduced a transport.h header. * Fixed the blocking mode to only change behavior not the actual underlying socket mode so we now always work with non-blocking sockets. This also introduces a new rule of thumb in libssh2 code: we don't call the external function calls internally. We use the internal (non-blocking) ones! * libssh2_channel_receive_window_adjust2 was added and libssh2_channel_receive_window_adjust is now deprecated * Introduced "local" header files with prototypes etc for different parts instead of cramming everything into libssh2_priv.h. channel.h is the first. 2009-03-26 15:41:14 +00:00			`* remove the following functions from the API/ABI`
one function to remove, one proto to correct 2009-03-23 13:54:16 +00:00
			`libssh2_base64_decode()`
			`libssh2_session_flag()`
* Renamed the functions in src/transport.c to be _libssh2_transport_ prefixed and introduced a transport.h header. * Fixed the blocking mode to only change behavior not the actual underlying socket mode so we now always work with non-blocking sockets. This also introduces a new rule of thumb in libssh2 code: we don't call the external function calls internally. We use the internal (non-blocking) ones! * libssh2_channel_receive_window_adjust2 was added and libssh2_channel_receive_window_adjust is now deprecated * Introduced "local" header files with prototypes etc for different parts instead of cramming everything into libssh2_priv.h. channel.h is the first. 2009-03-26 15:41:14 +00:00			`libssh2_channel_handle_extended_data()`
			`libssh2_channel_receive_window_adjust()`
libssh2_poll() and libssh2_poll_channel_read() are now considered and documented deprecated and they will be removed at next soname bump. It also saves us from fixing some rather quirky bugs in libssh2_poll()... 2009-04-14 21:38:36 +00:00			`libssh2_poll()`
			`libssh2_poll_channel_read()`
My knownhost work as of right now. It works at least partly. More tests and tweaks will come. 2009-05-07 13:09:48 +00:00
			`* Rename a few function:`

			`libssh2_hostkey_hash => libssh2_session_hostkey_hash`
change 'int' to 'libssh2_socket_t' in the public API for sockets 2010-03-06 19:51:37 +01:00			`libssh2_banner_set => libssh2_session_banner_set`

			`* change 'int' to 'libssh2_socket_t' in the public API for sockets.`