NAME libssh2_keepalive_config – short function description SYNOPSIS #include <libssh2.h> void libssh2_keepalive_config(LIBSSH2_SESSION *session, int want_reply, unsigned interval); DESCRIPTION Set how often keepalive messages should be sent. want_reply indicates whether the keepalive messages should request a response from the server. interval is number of seconds that can pass without any I/O, use 0 (the default) to disable…
NAME libssh2_init – global library initialization SYNOPSIS #include <libssh2.h> #define LIBSSH2_INIT_NO_CRYPTO 0x0001 int libssh2_init(int flags); DESCRIPTION Initialize the libssh2 functions. This typically initialize the crypto library. It uses a global state, and is not thread safe — you must make sure this function is not called concurrently. RETURN VALUE Returns 0 if succeeded, or a…
NAME libssh2_hostkey_hash – return a hash of the remote host’s key SYNOPSIS #include <libssh2.h> const char * libssh2_hostkey_hash(LIBSSH2_SESSION *session, int hash_type); DESCRIPTION session – Session instance as returned by libssh2_session_init_ex(3) hash_type – One of: LIBSSH2_HOSTKEY_HASH_MD5 or LIBSSH2_HOSTKEY_HASH_SHA1. Returns the computed digest of the remote system’s hostkey. The length of the returned string is hash_type specific…
NAME libssh2_free – deallocate libssh2 memory SYNOPSIS #include <libssh2.h> void libssh2_free(LIBSSH2_SESSION *session, void *ptr); DESCRIPTION Deallocate memory allocated by earlier call to libssh2 functions. It uses the memory allocation callbacks provided by the application, if any. Otherwise, this will just call free(). This function is mostly useful under Windows when libssh2 is linked to one…
NAME libssh2_exit – global library deinitialization SYNOPSIS #include <libssh2.h> void libssh2_exit(void); DESCRIPTION Exit the libssh2 functions and free’s all memory used internal. AVAILABILITY Added in libssh2 1.2.5 SEE ALSO libssh2_init(3) Index
NAME libssh2_channel_x11_req_ex – request an X11 forwarding channel SYNOPSIS #include <libssh2.h> int libssh2_channel_x11_req_ex(LIBSSH2_CHANNEL *channel, int single_connection, const char *auth_proto, const char *auth_cookie, int screen_number); int libssh2_channel_x11_req(LIBSSH2_CHANNEL *channel, int screen_number); DESCRIPTION channel – Previously opened channel instance such as returned by libssh2_channel_open_ex(3) single_connection – non-zero to only forward a single connection. auth_proto – X11 authentication protocol…
NAME libssh2_channel_x11_req – convenience macro for libssh2_channel_x11_req_ex(3) calls SYNOPSIS #include <libssh2.h> int libssh2_channel_x11_req(LIBSSH2_CHANNEL *channel, int screen_number); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_x11_req_ex(3). RETURN VALUE See libssh2_channel_x11_req_ex(3) ERRORS See libssh2_channel_x11_req_ex(3) SEE ALSO libssh2_channel_x11_req_ex(3) Index
NAME libssh2_channel_write_stderr – convenience macro for libssh2_channel_write_ex(3) SYNOPSIS #include <libssh2.h> ssize_t libssh2_channel_write_stderr(LIBSSH2_CHANNEL *channel, const char *buf, size_t buflen); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_write_ex(3). RETURN VALUE See libssh2_channel_write_ex(3) ERRORS See libssh2_channel_write_ex(3) SEE ALSO libssh2_channel_write_ex(3) Index
NAME libssh2_channel_write_ex – write data to a channel stream blocking SYNOPSIS #include <libssh2.h> ssize_t libssh2_channel_write_ex(LIBSSH2_CHANNEL *channel, int stream_id, char *buf, size_t buflen); DESCRIPTION Write data to a channel stream. All channel streams have one standard I/O substream (stream_id == 0), and may have up to 2^32 extended data streams as identified by the selected stream_id….
NAME libssh2_channel_write – convenience macro for libssh2_channel_write_ex(3) SYNOPSIS #include <libssh2.h> ssize_t libssh2_channel_write(LIBSSH2_CHANNEL *channel, const char *buf, size_t buflen); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_write_ex(3). RETURN VALUE See libssh2_channel_write_ex(3) ERRORS See libssh2_channel_write_ex(3) SEE ALSO libssh2_channel_write_ex(3) Index
NAME libssh2_channel_window_write_ex – Check the status of the write window SYNOPSIS #include <libssh2.h> unsigned long libssh2_channel_window_write_ex(LIBSSH2_CHANNEL *channel, unsigned long *window_size_initial) DESCRIPTION Check the status of the write window Returns the number of bytes which may be safely writen on the channel without blocking. ‘window_size_initial’ (if passed) will be populated with the size of the initial window…
NAME libssh2_channel_window_write – convenience macro for libssh2_channel_window_write_ex(3) calls SYNOPSIS #include <libssh2.h> unsigend long libssh2_channel_window_write(LIBSSH2_CHANNEL *channel); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_window_write_ex(3). RETURN VALUE See libssh2_channel_window_write_ex(3) ERRORS See libssh2_channel_window_write_ex(3) SEE ALSO libssh2_channel_window_write_ex(3) Index
NAME libssh2_channel_window_read_ex – Check the status of the read window SYNOPSIS #include <libssh2.h> unsigned long libssh2_channel_window_read_ex(LIBSSH2_CHANNEL *channel, unsigned long *read_avail, unsigned long *window_size_initial) DESCRIPTION Check the status of the read window. Returns the number of bytes which the remote end may send without overflowing the window limit read_avail (if passed) will be populated with the number of…
NAME libssh2_channel_window_read – convenience macro for libssh2_channel_window_read_ex(3) calls SYNOPSIS #include <libssh2.h> unsigned long libssh2_channel_window_read(LIBSSH2_CHANNEL *channel); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_window_read_ex(3). RETURN VALUE See libssh2_channel_window_read_ex(3) ERRORS See libssh2_channel_window_read_ex(3) SEE ALSO libssh2_channel_window_read_ex(3) Index
NAME libssh2_channel_wait_eof – wait for the remote to reply to an EOF request SYNOPSIS #include <libssh2.h> int libssh2_channel_wait_eof(LIBSSH2_CHANNEL *channel); DESCRIPTION Wait for the remote end to acknowledge an EOF request. RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it…
NAME libssh2_channel_wait_closed – wait for the remote to close the channel SYNOPSIS #include <libssh2.h> int libssh2_channel_wait_closed(LIBSSH2_CHANNEL *channel); DESCRIPTION Enter a temporary blocking state until the remote host closes the named channel. Typically sent after libssh2_channel_close(3) in order to examine the exit status. RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN…
NAME libssh2_channel_subsystem – convenience macro for libssh2_channel_process_startup(3) calls SYNOPSIS #include <libssh2.h> int libssh2_channel_subsystem(LIBSSH2_CHANNEL *channel, const char *subsystem); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_process_startup(3). RETURN VALUE See libssh2_channel_process_startup(3) ERRORS See libssh2_channel_process_startup(3) SEE ALSO libssh2_channel_process_startup(3) Index
NAME libssh2_channel_shell – convenience macro for libssh2_channel_process_startup(3) calls SYNOPSIS #include <libssh2.h> int libssh2_channel_shell(LIBSSH2_CHANNEL *channel); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_process_startup(3). RETURN VALUE See libssh2_channel_process_startup(3) ERRORS See libssh2_channel_process_startup(3) SEE ALSO libssh2_channel_process_startup(3) Index
NAME libssh2_channel_setenv_ex – set an environment variable on the channel SYNOPSIS #include <libssh2.h> int libssh2_channel_setenv_ex(LIBSSH2_CHANNEL *channel, char *varname, unsigned int varname_len, const char *value, unsigned int value_len); int libssh2_channel_setenv(LIBSSH2_CHANNEL *channel, char *varname, const char *value); DESCRIPTION channel – Previously opened channel instance such as returned by libssh2_channel_open_ex(3) varname – Name of environment variable to set…
NAME libssh2_channel_setenv – convenience macro for libssh2_channel_setenv_ex(3) calls SYNOPSIS #include <libssh2.h> int libssh2_channel_setenv(LIBSSH2_CHANNEL *channel, const char *varname, const char *value); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_setenv_ex(3). RETURN VALUE See libssh2_channel_setenv_ex(3) ERRORS See libssh2_channel_setenv_ex(3) SEE ALSO libssh2_channel_setenv_ex(3) Index