aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorAndreas Schneider <asn@cryptomilk.org>2011-03-09 18:32:09 +0100
committerAndreas Schneider <asn@cryptomilk.org>2011-03-09 18:33:03 +0100
commit7daa81f3aa876acb69a9cb332391dd218ac6838c (patch)
tree308e28f625194d350996e717a56a8189c1ac38de /include
parent6754c347117d8450c11f7ad3931caa7584820cfc (diff)
downloadlibssh-7daa81f3aa876acb69a9cb332391dd218ac6838c.tar.gz
libssh-7daa81f3aa876acb69a9cb332391dd218ac6838c.tar.xz
libssh-7daa81f3aa876acb69a9cb332391dd218ac6838c.zip
doc: Improve the doc of ssh_bind_set_callbacks.
Diffstat (limited to 'include')
-rw-r--r--include/libssh/server.h20
1 files changed, 20 insertions, 0 deletions
diff --git a/include/libssh/server.h b/include/libssh/server.h
index 50895fe1..d0cdd2db 100644
--- a/include/libssh/server.h
+++ b/include/libssh/server.h
@@ -157,6 +157,26 @@ LIBSSH_API int ssh_bind_options_set(ssh_bind sshbind,
*/
LIBSSH_API int ssh_bind_listen(ssh_bind ssh_bind_o);
+/**
+ * @brief Set the callback for this bind.
+ *
+ * @param[in] sshbind The bind to set the callback on.
+ *
+ * @param[in] callbacks An already set up ssh_bind_callbacks instance.
+ *
+ * @param[in] userdata A pointer to private data to pass to the callbacks.
+ *
+ * @return SSH_OK on success, SSH_ERROR if an error occured.
+ *
+ * @code
+ * struct ssh_callbacks_struct cb = {
+ * .userdata = data,
+ * .auth_function = my_auth_function
+ * };
+ * ssh_callbacks_init(&cb);
+ * ssh_bind_set_callbacks(session, &cb);
+ * @endcode
+ */
LIBSSH_API int ssh_bind_set_callbacks(ssh_bind sshbind, ssh_bind_callbacks callbacks,
void *userdata);