construct.xml

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

<refentry xml:id="syncsemaphore.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>SyncSemaphore::__construct</refname>
  <refpurpose>Construit un nouvel objet SyncSemaphore</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <methodname>SyncSemaphore::__construct</methodname>
   <methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>initialval</parameter><initializer>1</initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>autounlock</parameter><initializer>&true;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Construit un sémaphore nommé ou non.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>name</parameter></term>
    <listitem>
     <para>
      Le nom du sémaphore s'il est nommé.
     </para>
     <note>
      <para>
       Si le nom existe déjà, l'objet doit pouvoir être ouvert par l'utilisateur
       courant qui exécute le processus, ou une exception sera émise contenant
       le message d'erreur.
      </para>
     </note>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>initialval</parameter></term>
    <listitem>
     <para>
      La valeur initiale du sémaphore. Ce sera le nombre de verrous qui peuvent
      être obtenus.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>autounlock</parameter></term>
    <listitem>
     <para>
      Spécifie si l'on doit ou non déverouiller automatiquement le sémaphore
      à la fin du script PHP.
     </para>
     <warning>
      <para>
       Si l'objet est un sémaphore nommé dont l'autounlock vaut &false;, l'objet
       est verrouillé, et le script PHP se termine avant que l'objet ne soit
       déverouillé, alors le sémaphore sous-jacent se terminera dans un statut
       non consistent.
      </para>
     </warning>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Le nouvel objet <classname>SyncSemaphore</classname>.
  </para>
 </refsect1>
 
 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Une exception sera émise si le sémaphore ne peut
   être créé ou ouvert.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Exemple avec <function>SyncSemaphore::__construct</function></title>
   <programlisting role="php">
<![CDATA[
<?php
$semaphore = new SyncSemaphore("LimitedResource_2clients", 2);

if (!$semaphore->lock(3000))
{
    echo "Impossible de verrouiller le sémaphore.";

    exit();
}

/* ... */

$semaphore->unlock();
?>
]]>
   </programlisting>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>SyncSemaphore::lock</methodname></member>
   <member><methodname>SyncSemaphore::unlock</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
-->