diff options
author | Alan Dunn <amdunn@gmail.com> | 2014-03-21 08:51:34 -0500 |
---|---|---|
committer | Andreas Schneider <asn@cryptomilk.org> | 2014-03-27 10:49:08 +0100 |
commit | 47bd0b6d1f3176a4539c22741848d37b9357175b (patch) | |
tree | 294cdecdf138c0aac44ab2b3e3f2af43c9a6d5c1 /include/libssh/server.h | |
parent | 8e2590b5353f800a2dd11045a1e7ff4848fc8c25 (diff) | |
download | libssh-47bd0b6d1f3176a4539c22741848d37b9357175b.tar.gz libssh-47bd0b6d1f3176a4539c22741848d37b9357175b.tar.xz libssh-47bd0b6d1f3176a4539c22741848d37b9357175b.zip |
doc: Improve and consolidate ssh_bind_options_set docs
Signed-off-by: Alan Dunn <amdunn@gmail.com>
Reviewed-by: Andreas Schneider <asn@cryptomilk.org>
Diffstat (limited to 'include/libssh/server.h')
-rw-r--r-- | include/libssh/server.h | 63 |
1 files changed, 0 insertions, 63 deletions
diff --git a/include/libssh/server.h b/include/libssh/server.h index a1b80748..385a10a7 100644 --- a/include/libssh/server.h +++ b/include/libssh/server.h @@ -81,69 +81,6 @@ typedef struct ssh_bind_callbacks_struct *ssh_bind_callbacks; */ LIBSSH_API ssh_bind ssh_bind_new(void); -/** - * @brief Set the options for the current SSH server bind. - * - * @param sshbind The ssh server bind to configure. - * - * @param type The option type to set. This could be one of the - * following: - * - * - SSH_BIND_OPTIONS_BINDADDR - * The ip address to bind (const char *). - * - * - SSH_BIND_OPTIONS_BINDPORT - * The port to bind (unsigned int). - * - * - SSH_BIND_OPTIONS_BINDPORT_STR - * The port to bind (const char *). - * - * - SSH_BIND_OPTIONS_HOSTKEY - * This specifies the file containing the private host key used - * by SSHv1. (const char *). - * - * - SSH_BIND_OPTIONS_DSAKEY - * This specifies the file containing the private host dsa key - * used by SSHv2. (const char *). - * - * - SSH_BIND_OPTIONS_RSAKEY - * This specifies the file containing the private host dsa key - * used by SSHv2. (const char *). - * - * - SSH_BIND_OPTIONS_BANNER - * That the server banner (version string) for SSH. - * (const char *). - * - * - SSH_BIND_OPTIONS_LOG_VERBOSITY - * Set the session logging verbosity (int).\n - * \n - * The verbosity of the messages. Every log smaller or - * equal to verbosity will be shown. - * - SSH_LOG_NOLOG: No logging - * - SSH_LOG_RARE: Rare conditions or warnings - * - SSH_LOG_ENTRY: API-accessible entrypoints - * - SSH_LOG_PACKET: Packet id and size - * - SSH_LOG_FUNCTIONS: Function entering and leaving - * - * - SSH_BIND_OPTIONS_LOG_VERBOSITY_STR - * Set the session logging verbosity (const char *).\n - * \n - * The verbosity of the messages. Every log smaller or - * equal to verbosity will be shown. - * - SSH_LOG_NOLOG: No logging - * - SSH_LOG_RARE: Rare conditions or warnings - * - SSH_LOG_ENTRY: API-accessible entrypoints - * - SSH_LOG_PACKET: Packet id and size - * - SSH_LOG_FUNCTIONS: Function entering and leaving - * \n - * See the corresponding numbers in libssh.h. - * - * @param value The value to set. This is a generic pointer and the - * datatype which is used should be set according to the - * type set. - * - * @returns SSH_OK on success, SSH_ERROR on invalid option or parameter. - */ LIBSSH_API int ssh_bind_options_set(ssh_bind sshbind, enum ssh_bind_options_e type, const void *value); |