NAME libssh2_channel_set_blocking – set or clear blocking mode on channel SYNOPSIS #include <libssh2.h> void libssh2_channel_set_blocking(LIBSSH2_CHANNEL *channel, int blocking); DESCRIPTION channel – channel stream to set or clean blocking status on. blocking – Set to a non-zero value to make the channel block, or zero to make it non-blocking. Currently this is just a short cut…
NAME libssh2_channel_send_eof – send EOF to remote server SYNOPSIS #include <libssh2.h> int libssh2_channel_send_eof(LIBSSH2_CHANNEL *channel); DESCRIPTION Tell the remote host that no further data will be sent on the specified channel. Processes typically interpret this as a closed stdin descriptor. RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would…
NAME libssh2_channel_request_pty_size_ex – TODO SYNOPSIS DESCRIPTION RETURN VALUE ERRORS SEE ALSO Index
NAME libssh2_channel_request_pty_size – convenience macro for libssh2_channel_request_pty_size_ex(3) calls SYNOPSIS #include <libssh2.h> int libssh2_channel_request_pty_size(LIBSSH2_CHANNEL *channel, int width, int height); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_request_pty_size_ex(3). RETURN VALUE See libssh2_channel_request_pty_size_ex(3) ERRORS See libssh2_channel_request_pty_size_ex(3) SEE ALSO libssh2_channel_request_pty_size_ex(3) Index
NAME libssh2_channel_request_pty_ex – short function description SYNOPSIS #include <libssh2.h> int libssh2_channel_request_pty_ex(LIBSSH2_CHANNEL *channel, const char *term, unsigned int term_len, const char *modes, unsigned int modes_len, int width, int height, int width_px, int height_px); int libssh2_channel_request_pty(LIBSSH2_CHANNEL *channel, char *term); DESCRIPTION channel – Previously opened channel instance such as returned by libssh2_channel_open_ex(3) term – Terminal emulation (e.g. vt102,…
NAME libssh2_channel_request_pty – convenience macro for libssh2_channel_request_pty_ex(3) calls SYNOPSIS #include <libssh2.h> int libssh2_channel_request_pty(LIBSSH2_SESSION *session, const char *term); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_request_pty_ex(3). RETURN VALUE See libssh2_channel_request_pty_ex(3) ERRORS See libssh2_channel_request_pty_ex(3) SEE ALSO libssh2_channel_request_pty_ex(3) Index
NAME libssh2_channel_receive_window_adjust2 – adjust the channel window SYNOPSIS #include <libssh2.h> int libssh2_channel_receive_window_adjust2(LIBSSH2_CHANNEL * channel, unsigned long adjustment, unsigned char force, unsigned int *window); DESCRIPTION Adjust the receive window for a channel by adjustment bytes. If the amount to be adjusted is less than LIBSSH2_CHANNEL_MINADJUST and force is 0 the adjustment amount will be queued for a…
NAME libssh2_channel_receive_window_adjust – adjust the channel window SYNOPSIS #include <libssh2.h> unsigned long libssh2_channel_receive_window_adjust(LIBSSH2_CHANNEL * channel, unsigned long adjustment, unsigned char force); DESCRIPTION This function is deprecated in 1.1. Use libssh2_channel_receive_window_adjust2(3)! Adjust the receive window for a channel by adjustment bytes. If the amount to be adjusted is less than LIBSSH2_CHANNEL_MINADJUST and force is 0 the…
NAME libssh2_channel_read_stderr – convenience macro for libssh2_channel_read_ex(3) calls SYNOPSIS #include <libssh2.h> ssize_t libssh2_channel_read_stderr(LIBSSH2_CHANNEL *channel, 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_read_ex(3). RETURN VALUE See libssh2_channel_read_ex(3) ERRORS See libssh2_channel_read_ex(3) SEE ALSO libssh2_channel_read_ex(3) Index
NAME libssh2_channel_read_ex – read data from a channel stream SYNOPSIS #include <libssh2.h> ssize_t libssh2_channel_read_ex(LIBSSH2_CHANNEL *channel, int stream_id, char *buf, size_t buflen); ssize_t libssh2_channel_read(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen); ssize_t libssh2_channel_read_stderr(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen); DESCRIPTION Attempt to read data from an active channel stream. All channel streams have one standard I/O substream (stream_id ==…
NAME libssh2_channel_read – convenience macro for libssh2_channel_read_ex(3) calls SYNOPSIS #include <libssh2.h> ssize_t libssh2_channel_read(LIBSSH2_CHANNEL *channel, 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_read_ex(3). RETURN VALUE See libssh2_channel_read_ex(3) ERRORS See libssh2_channel_read_ex(3) SEE ALSO libssh2_channel_read_ex(3) Index
NAME libssh2_channel_process_startup – request a shell on a channel SYNOPSIS #include <libssh2.h> int libssh2_channel_process_startup(LIBSSH2_CHANNEL *channel, const char *request, unsigned int request_len, const char *message, unsigned int message_len); DESCRIPTION channel – Active session channel instance. request – Type of process to startup. The SSH2 protocol currently defines shell, exec, and subsystem as standard process services. request_len…
NAME libssh2_channel_open_session – convenience macro for libssh2_channel_open_ex(3) calls SYNOPSIS #include <libssh2.h> LIBSSH2_CHANNEL * libssh2_channel_open_session(LIBSSH2_SESSION *session); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_open_ex(3). RETURN VALUE See libssh2_channel_open_ex(3) ERRORS See libssh2_channel_open_ex(3) SEE ALSO libssh2_channel_open_ex(3) Index
NAME libssh2_channel_open_ex – establish a generic session channel SYNOPSIS #include <libssh2.h> LIBSSH2_CHANNEL * libssh2_channel_open_ex(LIBSSH2_SESSION *session, const char *channel_type, unsigned int channel_type_len, unsigned int window_size, unsigned int packet_size, const char *message, unsigned int message_len); LIBSSH2_CHANNEL * libssh2_channel_open_session(session); DESCRIPTION session – Session instance as returned by libssh2_session_init_ex(3) channel_type – Channel type to open. Typically one of session,…
NAME libssh2_channel_ignore_extended_data – convenience macro for libssh2_channel_handle_extended_data(3) calls SYNOPSIS #include <libssh2.h> libssh2_channel_ignore_extended_data(arguments) DESCRIPTION This function is deprecated. Use the libssh2_channel_handle_extended_data2(3) function instead! This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_handle_extended_data(3). RETURN VALUE See libssh2_channel_handle_extended_data(3) ERRORS See libssh2_channel_handle_extended_data(3) SEE ALSO libssh2_channel_handle_extended_data(3) Index
NAME libssh2_channel_handle_extended_data2 – set extended data handling mode SYNOPSIS #include <libssh2.h> int libssh2_channel_handle_extended_data2(LIBSSH2_CHANNEL *channel, int ignore_mode); DESCRIPTION channel – Active channel stream to change extended data handling on. ignore_mode – One of the three LIBSSH2_CHANNEL_EXTENDED_DATA_* Constants. LIBSSH2_CHANNEL_EXTENDED_DATA_NORMAL: Queue extended data for eventual reading LIBSSH2_CHANNEL_EXTENDED_DATA_MERGE: Treat extended data and ordinary data the same. Merge all substreams…
NAME libssh2_channel_handle_extended_data – set extended data handling mode SYNOPSIS #include <libssh2.h> void libssh2_channel_handle_extended_data(LIBSSH2_CHANNEL *channel, int ignore_mode); DESCRIPTION This function is deprecated. Use the libssh2_channel_handle_extended_data2(3) function instead! channel – Active channel stream to change extended data handling on. ignore_mode – One of the three LIBSSH2_CHANNEL_EXTENDED_DATA_* Constants. LIBSSH2_CHANNEL_EXTENDED_DATA_NORMAL: Queue extended data for eventual reading LIBSSH2_CHANNEL_EXTENDED_DATA_MERGE: Treat extended…
NAME libssh2_channel_get_exit_status – get the remote exit code SYNOPSIS #include <libssh2.h> int libssh2_channel_get_exit_status(LIBSSH2_CHANNEL* channel) DESCRIPTION channel – Closed channel stream to retreive exit status from. Returns the exit code raised by the process running on the remote host at the other end of the named channel. Note that the exit status may not be available…
NAME libssh2_channel_get_exit_signal – get the remote exit signal SYNOPSIS #include <libssh2.h> int libssh2_channel_get_exit_signal(LIBSSH2_CHANNEL *channel, char **exitsignal, size_t *exitsignal_len, char **errmsg, size_t *errmsg_len, char **langtag, size_t *langtag_len); DESCRIPTION channel – Closed channel stream to retrieve exit signal from. exitsignal – If not NULL, is populated by reference with the exit signal (without leading "SIG"). Note that…
NAME libssh2_channel_free – free all resources associated with a channel SYNOPSIS #include <libssh2.h> int libssh2_channel_free(LIBSSH2_CHANNEL *channel); DESCRIPTION channel – Channel stream to free. Release all resources associated with a channel stream. If the channel has not yet been closed with libssh2_channel_close(3) , it will be called automatically so that the remote end may know that…