<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="parallel-channel.make" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>parallel\Channel::make</refname>
  <refpurpose>Access</refpurpose>
 </refnamediv>

 <refsect1 role="description" audience="access">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>Channel</type><methodname>parallel\Channel::make</methodname>
   <methodparam><type>string</type><parameter>name</parameter></methodparam>
  </methodsynopsis>
  <para>
   Shall make an unbuffered channel with the given name
  </para>
  <methodsynopsis>
   <modifier>public</modifier> <type>Channel</type><methodname>parallel\Channel::make</methodname>
   <methodparam><type>string</type><parameter>name</parameter></methodparam>
   <methodparam><type>int</type><parameter>capacity</parameter></methodparam>
  </methodsynopsis>
  <para>
   Shall make a buffered channel with the given name and capacity
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>name</parameter></term>
    <listitem>
     <para>
      The name of the channel.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>capacity</parameter></term>
    <listitem>
     <para>
      May be <type>Channel::Infinite</type> or a positive integer
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="exceptions">
  <title>Exceptions</title>
  <warning>
   <para>
    Shall throw <type>parallel\Channel\Error\Existence</type> if channel already exists.
   </para>
  </warning>
 </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
-->
