construct.xml

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

<refentry xml:id="swoole-channel.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Swoole\Channel::__construct</refname>
  <refpurpose>Construct a Swoole Channel</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <constructorsynopsis>
   <modifier>public</modifier> <methodname>Swoole\Channel::__construct</methodname>
   <methodparam><type>string</type><parameter>size</parameter></methodparam>
  </constructorsynopsis>
  <para>
    Swoole channel is memory data structure works like Chan in Golang, implemented based on 
    shared memory and mutex locks. It can be used as high performance message queue in memory.
    Construct a swoole channel with a fixed size. The minimum size of a swoole channel is 64KB.
    Exceptions will be thrown if there is not enough memory.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>size</parameter></term>
    <listitem>
     <para>
      The size of the Swoole channel.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </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
-->