Section 3: library functions
libssh2_knownhost_add – add a known host Synopsis#include <libssh2.h> int libssh2_knownhost_add(LIBSSH2_KNOWNHOSTS *hosts, char *host, char *salt, char *key, size_t keylen, int typemask, struct libssh2_knownhost **store);DescriptionWe discourage use of this function as of libssh2 1.2.5. Instead we strongly urge users to use libssh2_knownhost_addc(3) instead, which as a more complete API. libssh2_knownhost_add(3) is subject for removal in a…
libssh2_keepalive_send – short function description Synopsis#include <libssh2.h> int libssh2_keepalive_send(LIBSSH2_SESSION *session, int *seconds_to_next);DescriptionSend a keepalive message if needed. seconds_to_next indicates how many seconds you can sleep after this call before you need to call it again. Return ValueReturns 0 on success, or LIBSSH2_ERROR_SOCKET_SEND on I/O errors. AvailabilityAdded in libssh2 1.2.5 See Alsolibssh2_keepalive_config(3)
libssh2_keepalive_config – short function description Synopsis#include <libssh2.h> void libssh2_keepalive_config(LIBSSH2_SESSION *session, int want_reply, unsigned interval);DescriptionSet 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 keepalives. To avoid some…
libssh2_init – global library initialization Synopsis#include <libssh2.h> #define LIBSSH2_INIT_NO_CRYPTO 0x0001 int libssh2_init(int flags); DescriptionInitialize 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 ValueReturns 0 if succeeded, or a negative value for error….
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); Descriptionsession – 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 (e.g. 16 bytes…
libssh2_free – deallocate libssh2 memory Synopsis#include <libssh2.h> void libssh2_free(LIBSSH2_SESSION *session, void *ptr); DescriptionDeallocate 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 run-time library and…
libssh2_exit – global library deinitialization Synopsis#include <libssh2.h> void libssh2_exit(void); DescriptionExit the libssh2 functions and free’s all memory used internal. AvailabilityAdded in libssh2 1.2.5 See Alsolibssh2_init(3)
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); Descriptionchannel – 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 to use auth_cookie…
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); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_x11_req_ex(3). Return ValueSee libssh2_channel_x11_req_ex(3) ErrorsSee libssh2_channel_x11_req_ex(3) See Alsolibssh2_channel_x11_req_ex(3)
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);DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_write_ex(3). Return ValueSee libssh2_channel_write_ex(3) ErrorsSee libssh2_channel_write_ex(3) See Alsolibssh2_channel_write_ex(3)
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);DescriptionWrite 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. The SSH2 protocol currently…
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);DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_write_ex(3). Return ValueSee libssh2_channel_write_ex(3) ErrorsSee libssh2_channel_write_ex(3) See Alsolibssh2_channel_write_ex(3)
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) DescriptionCheck 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 as defined by…
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); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_window_write_ex(3). Return ValueSee libssh2_channel_window_write_ex(3) ErrorsSee libssh2_channel_window_write_ex(3) See Alsolibssh2_channel_window_write_ex(3)
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) DescriptionCheck 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 bytes actually available…
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); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_window_read_ex(3). Return ValueSee libssh2_channel_window_read_ex(3) ErrorsSee libssh2_channel_window_read_ex(3) See Alsolibssh2_channel_window_read_ex(3)
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); DescriptionWait for the remote end to acknowledge an EOF request. Return ValueReturn 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 isn’t really a failure…
libssh2_channel_wait_closed – wait for the remote to close the channel Synopsis#include <libssh2.h> int libssh2_channel_wait_closed(LIBSSH2_CHANNEL *channel); DescriptionEnter 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 ValueReturn 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise…
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); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_process_startup(3). Return ValueSee libssh2_channel_process_startup(3) ErrorsSee libssh2_channel_process_startup(3) See Alsolibssh2_channel_process_startup(3)
libssh2_channel_shell – convenience macro for libssh2_channel_process_startup(3) calls Synopsis#include <libssh2.h> int libssh2_channel_shell(LIBSSH2_CHANNEL *channel); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_process_startup(3). Return ValueSee libssh2_channel_process_startup(3) ErrorsSee libssh2_channel_process_startup(3) See Alsolibssh2_channel_process_startup(3)