doc-en/reference/ssh2/functions/ssh2-keepalive-config.xml at 345b8089ca367f7f7c49f8e37131ff10c9762310 · php/doc-en · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
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
-->