NAME libssh2_session_init – convenience macro for libssh2_session_init_ex(3) calls SYNOPSIS #include <libssh2.h> LIBSSH2_SESSION * libssh2_session_init(void); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_session_init_ex(3). RETURN VALUE See libssh2_session_init_ex(3) ERRORS See libssh2_session_init_ex(3) SEE ALSO libssh2_session_init_ex(3) Index
NAME libssh2_session_hostkey – get the remote key SYNOPSIS #include <libssh2.h> const char *libssh2_session_hostkey(LIBSSH2_SESSION *session, size_t *len, int *type); DESCRIPTION Returns a pointer to the current host key, the value len points to will get the length of the key. The value type points to the type of hostkey which is one of: LIBSSH2_HOSTKEY_TYPE_RSA, LIBSSH2_HOSTKEY_TYPE_DSS, or LIBSSH2_HOSTKEY_TYPE_UNKNOWN. RETURN…
NAME libssh2_session_get_timeout – get the timeout for blocking functions SYNOPSIS #include <libssh2.h> long libssh2_session_get_timeout(LIBSSH2_SESSION *session); DESCRIPTION Returns the timeout (in milliseconds) for how long a blocking the libssh2 function calls may wait until they consider the situation an error and return LIBSSH2_ERROR_TIMEOUT. By default libssh2 has no timeout (zero) for blocking functions. RETURN VALUE The…
NAME libssh2_session_get_blocking – TODO SYNOPSIS int libssh2_session_get_blocking(LIBSSH2_SESSION *session); DESCRIPTION Returns 0 if the state of the session has previously be set to non-blocking and it returns 1 if the state was set to blocking. RETURN VALUE See description. SEE ALSO libssh2_session_set_blocking(3) Index
NAME libssh2_session_free – frees resources associated with a session instance SYNOPSIS #include <libssh2.h> int libssh2_session_free(LIBSSH2_SESSION *session); DESCRIPTION Frees all resources associated with a session instance. Typically called after libssh2_session_disconnect_ex(3) 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 isn’t…
NAME libssh2_session_flag – TODO SYNOPSIS int libssh2_session_flag(LIBSSH2_SESSION *session, int flag, int value); DESCRIPTION Set options for the created session. flag is the option to set, while value is typically set to 1 or 0 to enable or disable the option. FLAGS LIBSSH2_FLAG_SIGPIPE If set, libssh2 will not attempt to block SIGPIPEs but will let them…
NAME libssh2_session_disconnect_ex – terminate transport layer SYNOPSIS #include <libssh2.h> int libssh2_session_disconnect_ex(LIBSSH2_SESSION *session, int reason, const char *description, const char *lang); int libssh2_session_disconnect(LIBSSH2_SESSION *session, const char *description); DESCRIPTION session – Session instance as returned by libssh2_session_init_ex(3) reason – One of the Disconnect Reason constants. description – Human readable reason for disconnection. lang – Localization string describing…
NAME libssh2_session_disconnect – convenience macro for libssh2_session_disconnect_ex(3) calls SYNOPSIS #include <libssh2.h> int libssh2_session_disconnect(LIBSSH2_SESSION *session, const char *description); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_session_disconnect_ex(3). RETURN VALUE See libssh2_session_disconnect_ex(3) ERRORS See libssh2_session_disconnect_ex(3) SEE ALSO libssh2_session_disconnect_ex(3) Index
NAME libssh2_session_callback_set – set a callback function SYNOPSIS #include <libssh2.h> void *libssh2_session_callback_set(LIBSSH2_SESSION *session, int cbtype, void *callback); DESCRIPTION Sets a custom callback handler for a previously initialized session object. Callbacks are triggered by the receipt of special packets at the Transport layer. To disable a callback, set it to NULL. session – Session instance as…
NAME libssh2_session_block_directions – get directions to wait for SYNOPSIS #include <libssh2.h> int libssh2_session_block_directions(LIBSSH2_SESSION *session); DESCRIPTION session – Session instance as returned by libssh2_session_init_ex(3) When any of libssh2 functions return LIBSSH2_ERROR_EAGAIN an application should wait for the socket to have data available for reading or writing. Depending on the return value of libssh2_session_block_directions(3) an application should…
NAME libssh2_session_banner_set – set the SSH prococol banner for the local client SYNOPSIS #include <libssh2.h> int libssh2_session_banner_set(LIBSSH2_SESSION *session, const char *banner); DESCRIPTION session – Session instance as returned by libssh2_session_init_ex(3) banner – A pointer to a zero-terminated string holding the user defined banner Set the banner that will be sent to the remote host when…
NAME libssh2_session_banner_get – get the remote banner SYNOPSIS #include <libssh2.h> const char *libssh2_session_banner_get(oLIBSSH2_SESSION *session); DESCRIPTION Once the session has been setup and libssh2_session_handshake(3) has completed successfully, this function can be used to get the server id from the banner each server presents. RETURN VALUE A pointer to a string or NULL if something failed. The…
NAME libssh2_session_abstract – return a pointer to a session’s abstract pointer SYNOPSIS #include <libssh2.h> void ** libssh2_session_abstract(LIBSSH2_SESSION *session); DESCRIPTION session – Session instance as returned by libssh2_session_init_ex(3) Return a pointer to where the abstract pointer provided to libssh2_session_init_ex(3) is stored. By providing a doubly de-referenced pointer, the internal storage of the session instance may be…
NAME libssh2_scp_send_ex – Send a file via SCP SYNOPSIS #include <libssh2.h> LIBSSH2_CHANNEL * libssh2_scp_send_ex(LIBSSH2_SESSION *session, const char *path, int mode, size_t size, long mtime, long atime); DESCRIPTION This function has been deemed deprecated since libssh2 1.2.6. See libssh2_scp_send64(3). session – Session instance as returned by libssh2_session_init_ex(3) path – Full path and filename of file to…
NAME libssh2_scp_send64 – Send a file via SCP SYNOPSIS #include <libssh2.h> LIBSSH2_CHANNEL * libssh2_scp_send64(LIBSSH2_SESSION *session, const char *path, int mode, libssh2_uint64_t size, time_t mtime, time_t atime); DESCRIPTION session – Session instance as returned by libssh2_session_init_ex(3) path – Full path and filename of file to transfer to. That is the remote file name. mode – File…
NAME libssh2_scp_send – convenience macro for libssh2_scp_send_ex(3) calls SYNOPSIS #include <libssh2.h> LIBSSH2_CHANNEL * libssh2_scp_send(LIBSSH2_SESSION *session, const char *path, int mode, size_t size); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_scp_send_ex(3). RETURN VALUE See libssh2_scp_send_ex(3) ERRORS See libssh2_scp_send_ex(3) SEE ALSO libssh2_scp_send_ex(3) Index
NAME libssh2_scp_recv – request a remote file via SCP SYNOPSIS #include <libssh2.h> LIBSSH2_CHANNEL * libssh2_scp_recv(LIBSSH2_SESSION *session, const char *path, struct stat *sb); DESCRIPTION session – Session instance as returned by libssh2_session_init_ex(3) path – Full path and filename of file to transfer. That is the remote file name. sb – Populated with remote file’s size, mode,…
NAME libssh2_publickey_shutdown – TODO SYNOPSIS DESCRIPTION RETURN VALUE ERRORS SEE ALSO Index
NAME libssh2_publickey_list_remove_ex – TODO SYNOPSIS DESCRIPTION RETURN VALUE ERRORS SEE ALSO Index
NAME libssh2_publickey_remove – convenience macro for libssh2_publickey_remove_ex(3) calls SYNOPSIS #include <libssh2.h> int libssh2_publickey_remove(LIBSSH2_PUBLICKEY *pkey, const unsigned char *name, unsigned long name_len, const unsigned char *blob, unsigned long blob_len); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_publickey_remove_ex(3). RETURN VALUE See libssh2_publickey_remove_ex(3) ERRORS See…