<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ssh2.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'es',
  ),
  'this' => 
  array (
    0 => 'function.ssh2-keepalive-config.php',
    1 => 'ssh2_keepalive_config',
    2 => 'Configura la frecuencia de env&iacute;o de los mensajes de mantenimiento de conexi&oacute;n',
  ),
  'up' => 
  array (
    0 => 'ref.ssh2.php',
    1 => 'Funciones de SSH2',
  ),
  'prev' => 
  array (
    0 => 'function.ssh2-forward-listen.php',
    1 => 'ssh2_forward_listen',
  ),
  'next' => 
  array (
    0 => 'function.ssh2-keepalive-send.php',
    1 => 'ssh2_keepalive_send',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'es',
    'path' => 'reference/ssh2/functions/ssh2-keepalive-config.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.ssh2-keepalive-config" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ssh2_keepalive_config</h1>
  <p class="verinfo">(PECL ssh2 &gt;= 1.5.0)</p><p class="refpurpose"><span class="refname">ssh2_keepalive_config</span> &mdash; <span class="dc-title">Configura la frecuencia de envío de los mensajes de mantenimiento de conexión</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.ssh2-keepalive-config-description">
  <h3 class="title">Descripción</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">function</span> <span class="methodname"><strong>ssh2_keepalive_config</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$session</code></span>, <span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$want_reply</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$interval</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>

  <p class="simpara">
   Configura con qué frecuencia se envían los mensajes de mantenimiento de
   conexión en la <code class="parameter">session</code> indicada, y si se solicita al
   servidor que responda a ellos.
  </p>
  <p class="simpara">
   Los mensajes de mantenimiento de conexión no se envían automáticamente. Una
   vez configurados, se debe llamar a <span class="function"><a href="function.ssh2-keepalive-send.php" class="function">ssh2_keepalive_send()</a></span>
   para enviar realmente un mensaje de mantenimiento de conexión.
  </p>
  <blockquote class="note"><p><strong class="note">Nota</strong>: 
   <p class="simpara">
    Esta función solo está disponible cuando la extensión se compila con una
    versión de libssh2 que proporciona soporte de mantenimiento de conexión.
   </p>
  </p></blockquote>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.ssh2-keepalive-config-parameters">
  <h3 class="title">Parámetros</h3>
  <dl>
   
    <dt><code class="parameter">session</code></dt>
    <dd>
     <p class="simpara">
      Un identificador de enlace de conexión SSH, obtenido de una llamada a
      <span class="function"><a href="function.ssh2-connect.php" class="function">ssh2_connect()</a></span>.
     </p>
    </dd>
   
   
    <dt><code class="parameter">want_reply</code></dt>
    <dd>
     <p class="simpara">
      Indica si se solicita al servidor que responda a los mensajes de
      mantenimiento de conexión. Solicitar una respuesta permite detectar un
      servidor que no responde, a costa de algo de tráfico adicional.
     </p>
    </dd>
   
   
    <dt><code class="parameter">interval</code></dt>
    <dd>
     <p class="simpara">
      El número de segundos que pueden transcurrir sin ningún tráfico antes de
      que deba enviarse un mensaje de mantenimiento de conexión. El valor
      <code class="literal">0</code> deshabilita los mensajes de mantenimiento de
      conexión, y el valor <code class="literal">1</code> es tratado como
      <code class="literal">2</code> por la biblioteca subyacente.
     </p>
     <p class="simpara">
      Los valores aceptados van de <code class="literal">0</code> a
      <code class="literal">4294967295</code>.
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.ssh2-keepalive-config-returnvalues">
  <h3 class="title">Valores devueltos</h3>
  <p class="simpara">
   No se retorna ningún valor.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.ssh2-keepalive-config-errors">
  <h3 class="title">Errores/Excepciones</h3>
  <p class="simpara">
   Se emite un error de nivel <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong> cuando
   <code class="parameter">interval</code> queda fuera del rango aceptado; en ese caso
   la configuración del mantenimiento de conexión permanece sin cambios.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.ssh2-keepalive-config-examples">
  <h3 class="title">Ejemplos</h3>
  <div class="example" id="example-1">
   <p><strong>Ejemplo #1 Envío de mensajes de mantenimiento de conexión</strong></p>
   <div class="example-contents">
<div class="phpcode"><pre><code style="color: #000000"><span style="color: #0000BB">&lt;?php
$connection </span><span style="color: #007700">= </span><span style="color: #0000BB">ssh2_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'shell.example.com'</span><span style="color: #007700">, </span><span style="color: #0000BB">22</span><span style="color: #007700">);
</span><span style="color: #0000BB">ssh2_auth_password</span><span style="color: #007700">(</span><span style="color: #0000BB">$connection</span><span style="color: #007700">, </span><span style="color: #DD0000">'username'</span><span style="color: #007700">, </span><span style="color: #DD0000">'password'</span><span style="color: #007700">);

</span><span style="color: #FF8000">// Solicita una respuesta del servidor, tras 30 segundos sin ningún tráfico
</span><span style="color: #0000BB">ssh2_keepalive_config</span><span style="color: #007700">(</span><span style="color: #0000BB">$connection</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">, </span><span style="color: #0000BB">30</span><span style="color: #007700">);

</span><span style="color: #FF8000">// Los mensajes de mantenimiento de conexión solo se envían en esta llamada
</span><span style="color: #0000BB">ssh2_keepalive_send</span><span style="color: #007700">(</span><span style="color: #0000BB">$connection</span><span style="color: #007700">);
</span><span style="color: #0000BB">?&gt;</span></code></pre></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.ssh2-keepalive-config-seealso">
  <h3 class="title">Véase también</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.ssh2-keepalive-send.php" class="function" rel="rdfs-seeAlso">ssh2_keepalive_send()</a> - Env&iacute;a un mensaje de mantenimiento de conexi&oacute;n</span></li>
   <li><span class="function"><a href="function.ssh2-connect.php" class="function" rel="rdfs-seeAlso">ssh2_connect()</a> - Conexi&oacute;n a un servidor SSH</span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>