call.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c50df321d2cccb1044219a98d4c5c7677d4b29cf Maintainer: lacatoire Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="yar-concurrent-client.call" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Yar_Concurrent_Client::call</refname>
  <refpurpose>Enregistre un appel concurrent</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <modifier>static</modifier> <type>int</type><methodname>Yar_Concurrent_Client::call</methodname>
   <methodparam><type>string</type><parameter>uri</parameter></methodparam>
   <methodparam><type>string</type><parameter>method</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>parameters</parameter></methodparam>
   <methodparam choice="opt"><type>callable</type><parameter>callback</parameter></methodparam>
   <methodparam choice="opt"><type>callable</type><parameter>error_callback</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
  </methodsynopsis>
  <para>
   Enregistre un appel RPC, mais ne l'envoie pas immédiatement ; il sera
   envoyé pendant l'appel à la méthode
   <methodname>Yar_Concurrent_Client::loop</methodname>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>uri</parameter></term>
    <listitem>
     <para>
       L'URI du serveur RPC (HTTP, TCP).
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>method</parameter></term>
    <listitem>
     <para>
      Nom du service (i.e. le nom de la méthode).
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>parameters</parameter></term>
    <listitem>
     <para>
      Paramètres.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>callback</parameter></term>
    <listitem>
     <para>
      Une fonction de rappel, qui sera appelée par le retour de la réponse.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>error_callback</parameter></term>
    <listitem>
     <simpara>
      Si cette fonction de rappel est définie, alors Yar l'appellera lorsqu'une erreur surviendra.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>options</parameter></term>
    <listitem>
     <simpara>
      Un &array; d'options.
      Voir la liste des <link linkend="yar.constants">constantes</link>.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   Un ID unique ; peut être utilisé pour identifier l'appel.
  </simpara>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <informalexample>
   <programlisting role="php">
<![CDATA[
<?php

function callback($retval, $callinfo)
{
    var_dump($retval);
}

function error_callback($type, $error, $callinfo)
{
    error_log($error);
}

Yar_Concurrent_Client::call("http://host/api/", "some_method", array("parameters"), "callback");

// Si la fonction de rappel n'est pas spécifiée, la fonction de rappel de la boucle sera utilisée
Yar_Concurrent_Client::call("http://host/api/", "some_method", array("parameters"));

// Ce serveur accepte le packager JSON
Yar_Concurrent_Client::call("http://host/api/", "some_method", array("parameters"), "callback", NULL, array(YAR_OPT_PACKAGER => "json"));

// Délai d'attente maximal personnalisé
Yar_Concurrent_Client::call("http://host/api/", "some_method", array("parameters"), "callback", NULL, array(YAR_OPT_TIMEOUT => 1));

// Les requêtes ne sont pas envoyées pour le moment
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
]]>
   </screen>
  </informalexample>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>Yar_Concurrent_Client::loop</methodname></member>
   <member><methodname>Yar_Concurrent_Client::reset</methodname></member>
   <member><methodname>Yar_Server::__construct</methodname></member>
   <member><methodname>Yar_Server::handle</methodname></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
-->