aboutsummaryrefslogtreecommitdiff
path: root/include/libssh/callbacks.h
diff options
context:
space:
mode:
authorAudrius Butkevicius <audrius.butkevicius@gmail.com>2014-01-26 03:16:36 +0000
committerAndreas Schneider <asn@cryptomilk.org>2014-02-02 22:19:46 +0100
commitadf4d4f14748b6373e3b490f6b5216378801e7e7 (patch)
treeb67f67dbc08a243720e91de3bf7f2bf342089096 /include/libssh/callbacks.h
parentdc93edc932169566433e208df58ff5dd027774a4 (diff)
downloadlibssh-adf4d4f14748b6373e3b490f6b5216378801e7e7.tar.gz
libssh-adf4d4f14748b6373e3b490f6b5216378801e7e7.tar.xz
libssh-adf4d4f14748b6373e3b490f6b5216378801e7e7.zip
doc: Document expected return value of channel data callback
Signed-off-by: Audrius Butkevicius <audrius.butkevicius@gmail.com> Reviewed-by: Andreas Schneider <asn@cryptomilk.org>
Diffstat (limited to 'include/libssh/callbacks.h')
-rw-r--r--include/libssh/callbacks.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/include/libssh/callbacks.h b/include/libssh/callbacks.h
index 9aa8bab7..6bd8c573 100644
--- a/include/libssh/callbacks.h
+++ b/include/libssh/callbacks.h
@@ -495,6 +495,8 @@ LIBSSH_API int ssh_set_callbacks(ssh_session session, ssh_callbacks cb);
* @param len the length of the data
* @param is_stderr is 0 for stdout or 1 for stderr
* @param userdata Userdata to be passed to the callback function.
+ * @returns number of bytes processed by the callee. The remaining bytes will
+ * be sent in the next callback message, when more data is available.
*/
typedef int (*ssh_channel_data_callback) (ssh_session session,
ssh_channel channel,