diff --git a/reference/ssh2/functions/ssh2-keepalive-config.xml b/reference/ssh2/functions/ssh2-keepalive-config.xml new file mode 100644 index 000000000000..a3de76dc1238 --- /dev/null +++ b/reference/ssh2/functions/ssh2-keepalive-config.xml @@ -0,0 +1,104 @@ + + + + + ssh2_keepalive_config + Configure how often keepalive messages should be sent + + + + &reftitle.description; + + voidssh2_keepalive_config + resourcesession + boolwant_reply + intinterval + + + Configures how often keepalive messages are sent on the given + session, and whether the server is asked to reply to + them. + + + Keepalive messages are not sent automatically. Once configured, + ssh2_keepalive_send must be called to actually send a + keepalive message. + + + + The ssh2_keepalive_config function will only be + available when the ssh2 extension is compiled with libssh keepalive + support. + + + + + + &reftitle.parameters; + + + session + + + An SSH connection link identifier, obtained from a call to + ssh2_connect. + + + + + want_reply + + + Whether the server is requested to reply to keepalive messages. + + + + + interval + + + The number of seconds that may pass without any traffic before a + keepalive message should be sent. A value of 0 + disables keepalive messages. + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.seealso; + + ssh2_keepalive_send + ssh2_connect + + + + + diff --git a/reference/ssh2/functions/ssh2-keepalive-send.xml b/reference/ssh2/functions/ssh2-keepalive-send.xml new file mode 100644 index 000000000000..5734fc8ccf11 --- /dev/null +++ b/reference/ssh2/functions/ssh2-keepalive-send.xml @@ -0,0 +1,80 @@ + + + + + ssh2_keepalive_send + Send a keepalive message + + + + &reftitle.description; + + intfalsessh2_keepalive_send + resourcesession + + + Sends a keepalive message on the given session, + according to the configuration set with + ssh2_keepalive_config. + + + + The ssh2_keepalive_send function will only be + available when the ssh2 extension is compiled with libssh keepalive + support. + + + + + + &reftitle.parameters; + + + session + + + An SSH connection link identifier, obtained from a call to + ssh2_connect. + + + + + + + + &reftitle.returnvalues; + + Returns the number of seconds that may pass before another keepalive message + must be sent, or &false; on failure. + + + + + &reftitle.seealso; + + ssh2_keepalive_config + ssh2_connect + + + + + diff --git a/reference/ssh2/functions/ssh2-send-signal.xml b/reference/ssh2/functions/ssh2-send-signal.xml new file mode 100644 index 000000000000..47e23315567e --- /dev/null +++ b/reference/ssh2/functions/ssh2-send-signal.xml @@ -0,0 +1,90 @@ + + + + + ssh2_send_signal + Send a signal to the remote process of a channel + + + + &reftitle.description; + + boolssh2_send_signal + resourcechannel + stringsignal + + + Sends a signal to the process running at the remote end of the given + channel. + + + + The ssh2_send_signal function will only be available + when the ssh2 extension is compiled with libssh >= 1.9.0. + + + + + + &reftitle.parameters; + + + channel + + + An SSH channel stream, as returned by ssh2_exec or + ssh2_shell. + + + + + signal + + + The name of the signal to send, without the SIG + prefix, as defined by the SSH connection protocol + (RFC 4254); for + example TERM, KILL or + INT. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.seealso; + + ssh2_exec + ssh2_shell + + + + + diff --git a/reference/ssh2/functions/ssh2-set-timeout.xml b/reference/ssh2/functions/ssh2-set-timeout.xml new file mode 100644 index 000000000000..a2ed201a730f --- /dev/null +++ b/reference/ssh2/functions/ssh2-set-timeout.xml @@ -0,0 +1,96 @@ + + + + + ssh2_set_timeout + Set timeout for the SSH session + + + + &reftitle.description; + + voidssh2_set_timeout + resourcesession + intseconds + intmicroseconds0 + + + Sets how long a blocking operation on the given + session may wait before it is considered to have + timed out. + + + + The ssh2_set_timeout function will only be available + when the ssh2 extension is compiled with libssh >= 1.2.9. + + + + + + &reftitle.parameters; + + + session + + + An SSH connection link identifier, obtained from a call to + ssh2_connect. + + + + + seconds + + + The timeout, in seconds. A value of 0 means that no + timeout is applied and blocking operations may wait indefinitely. + + + + + microseconds + + + An additional number of microseconds added to the timeout. + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.seealso; + + ssh2_connect + + + + + diff --git a/reference/ssh2/functions/ssh2-shell-resize.xml b/reference/ssh2/functions/ssh2-shell-resize.xml new file mode 100644 index 000000000000..266b39a38f9d --- /dev/null +++ b/reference/ssh2/functions/ssh2-shell-resize.xml @@ -0,0 +1,105 @@ + + + + + ssh2_shell_resize + Change the dimensions of a shell's pseudo-terminal + + + + &reftitle.description; + + boolssh2_shell_resize + resourceshell + intwidth + intheight + intwidth_px0 + intheight_px0 + + + Requests that the pseudo-terminal (PTY) attached to the given + shell be resized to the given dimensions. + + + + + &reftitle.parameters; + + + shell + + + An SSH shell stream, as returned by ssh2_shell. + + + + + width + + + The width of the terminal, in characters. + + + + + height + + + The height of the terminal, in characters. + + + + + width_px + + + The width of the terminal, in pixels. + + + + + height_px + + + The height of the terminal, in pixels. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.seealso; + + ssh2_shell + + + + + diff --git a/reference/ssh2/versions.xml b/reference/ssh2/versions.xml index 24bf2fa898e4..f7251a1aed55 100644 --- a/reference/ssh2/versions.xml +++ b/reference/ssh2/versions.xml @@ -17,6 +17,8 @@ + + @@ -26,6 +28,8 @@ + + @@ -38,6 +42,7 @@ +