diff options
| author | Audrius Butkevicius <audrius.butkevicius@gmail.com> | 2014-01-26 03:16:36 +0000 |
|---|---|---|
| committer | Andreas Schneider <asn@cryptomilk.org> | 2014-02-02 22:21:07 +0100 |
| commit | 45d28c76829c96ff23d328c8420e936cf0ef1e72 (patch) | |
| tree | 5b83edabf1de1a5b348640643f1ad15d4945dfd7 /include | |
| parent | 2786565e775d4ea7c3b9c034fd0c2ef6094df099 (diff) | |
| download | libssh-45d28c76829c96ff23d328c8420e936cf0ef1e72.tar.gz libssh-45d28c76829c96ff23d328c8420e936cf0ef1e72.tar.xz libssh-45d28c76829c96ff23d328c8420e936cf0ef1e72.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')
| -rw-r--r-- | include/libssh/callbacks.h | 2 |
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, |