Skip to content

ssh2: document five previously undocumented functions #5688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lacatoire wants to merge 1 commit into
base: master
Choose a base branch
from
Open

ssh2: document five previously undocumented functions #5688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 104 additions & 0 deletions reference/ssh2/functions/ssh2-keepalive-config.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ssh2-keepalive-config" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ssh2_keepalive_config</refname>
<refpurpose>Configure how often keepalive messages should be sent</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="procedural">
<type>void</type><methodname>ssh2_keepalive_config</methodname>
<methodparam><type>resource</type><parameter>session</parameter></methodparam>
<methodparam><type>bool</type><parameter>want_reply</parameter></methodparam>
<methodparam><type>int</type><parameter>interval</parameter></methodparam>
</methodsynopsis>
<simpara>
Configures how often keepalive messages are sent on the given
<parameter>session</parameter>, and whether the server is asked to reply to
them.
</simpara>
<simpara>
Keepalive messages are not sent automatically. Once configured,
<function>ssh2_keepalive_send</function> must be called to actually send a
keepalive message.
</simpara>
<note>
<simpara>
The <function>ssh2_keepalive_config</function> function will only be
available when the ssh2 extension is compiled with libssh keepalive
support.
</simpara>
</note>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
<simpara>
An SSH connection link identifier, obtained from a call to
<function>ssh2_connect</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>want_reply</parameter></term>
<listitem>
<simpara>
Whether the server is requested to reply to keepalive messages.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>interval</parameter></term>
<listitem>
<simpara>
The number of seconds that may pass without any traffic before a
keepalive message should be sent. A value of <literal>0</literal>
disables keepalive messages.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
&return.void;
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>ssh2_keepalive_send</function></member>
<member><function>ssh2_connect</function></member>
</simplelist>
</refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
80 changes: 80 additions & 0 deletions reference/ssh2/functions/ssh2-keepalive-send.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ssh2-keepalive-send" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ssh2_keepalive_send</refname>
<refpurpose>Send a keepalive message</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="procedural">
<type class="union"><type>int</type><type>false</type></type><methodname>ssh2_keepalive_send</methodname>
<methodparam><type>resource</type><parameter>session</parameter></methodparam>
</methodsynopsis>
<simpara>
Sends a keepalive message on the given <parameter>session</parameter>,
according to the configuration set with
<function>ssh2_keepalive_config</function>.
</simpara>
<note>
<simpara>
The <function>ssh2_keepalive_send</function> function will only be
available when the ssh2 extension is compiled with libssh keepalive
support.
</simpara>
</note>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
<simpara>
An SSH connection link identifier, obtained from a call to
<function>ssh2_connect</function>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Returns the number of seconds that may pass before another keepalive message
must be sent, or &false; on failure.
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>ssh2_keepalive_config</function></member>
<member><function>ssh2_connect</function></member>
</simplelist>
</refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
90 changes: 90 additions & 0 deletions reference/ssh2/functions/ssh2-send-signal.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ssh2-send-signal" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ssh2_send_signal</refname>
<refpurpose>Send a signal to the remote process of a channel</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="procedural">
<type>bool</type><methodname>ssh2_send_signal</methodname>
<methodparam><type>resource</type><parameter>channel</parameter></methodparam>
<methodparam><type>string</type><parameter>signal</parameter></methodparam>
</methodsynopsis>
<simpara>
Sends a signal to the process running at the remote end of the given
<parameter>channel</parameter>.
</simpara>
<note>
<simpara>
The <function>ssh2_send_signal</function> function will only be available
when the ssh2 extension is compiled with libssh &gt;= 1.9.0.
</simpara>
</note>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>channel</parameter></term>
<listitem>
<simpara>
An SSH channel stream, as returned by <function>ssh2_exec</function> or
<function>ssh2_shell</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>signal</parameter></term>
<listitem>
<simpara>
The name of the signal to send, without the <literal>SIG</literal>
prefix, as defined by the SSH connection protocol
(<link xlink:href="&url.rfc;4254">RFC 4254</link>); for
example <literal>TERM</literal>, <literal>KILL</literal> or
<literal>INT</literal>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
&return.success;
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>ssh2_exec</function></member>
<member><function>ssh2_shell</function></member>
</simplelist>
</refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
96 changes: 96 additions & 0 deletions reference/ssh2/functions/ssh2-set-timeout.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ssh2-set-timeout" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ssh2_set_timeout</refname>
<refpurpose>Set timeout for the SSH session</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="procedural">
<type>void</type><methodname>ssh2_set_timeout</methodname>
<methodparam><type>resource</type><parameter>session</parameter></methodparam>
<methodparam><type>int</type><parameter>seconds</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>microseconds</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<simpara>
Sets how long a blocking operation on the given
<parameter>session</parameter> may wait before it is considered to have
timed out.
</simpara>
<note>
<simpara>
The <function>ssh2_set_timeout</function> function will only be available
when the ssh2 extension is compiled with libssh &gt;= 1.2.9.
</simpara>
</note>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
<simpara>
An SSH connection link identifier, obtained from a call to
<function>ssh2_connect</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>seconds</parameter></term>
<listitem>
<simpara>
The timeout, in seconds. A value of <literal>0</literal> means that no
timeout is applied and blocking operations may wait indefinitely.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>microseconds</parameter></term>
<listitem>
<simpara>
An additional number of microseconds added to the timeout.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
&return.void;
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>ssh2_connect</function></member>
</simplelist>
</refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Loading