libstdc++-v3/doc/xml/manual/concurrency.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
   4 [ ]>
   5
   6 <chapter id="std.concurrency" xreflabel="Concurrency">
   7 <?dbhtml filename="concurrency.html"?>
   8
   9 <chapterinfo>
  10   <keywordset>
  11     <keyword>
  12       ISO C++
  13     </keyword>
  14     <keyword>
  15       library
  16     </keyword>
  17     <keyword>
  18       mutex
  19     </keyword>
  20     <keyword>
  21       thread
  22     </keyword>
  23     <keyword>
  24       future
  25     </keyword>
  26     <keyword>
  27       condition_variable
  28     </keyword>
  29   </keywordset>
  30 </chapterinfo>
  31
  32 <title>
  33   Concurrency
  34   <indexterm><primary>Concurrency</primary></indexterm>
  35 </title>
  36
  37 <para>
  38   Facilities for concurrent operation, and control thereof.
  39 </para>
  40
  41
  42 <!-- Sect1 01 : API -->
  43 <sect1 id="std.concurrency.api">
  44   <title>API Reference</title>
  45
  46   <para>
  47     All items are declared in one of four standard header files.
  48   </para>
  49
  50   <para>
  51     In header <filename>mutex</filename>, class
  52     template <classname>mutex</classname> and variants,
  53     class <classname>once_flag</classname>, and class
  54     template <classname>unique_lock</classname>.
  55   </para>
  56
  57   <para>
  58     In header <filename>condition_variable</filename>,
  59     classes <classname>condition_variable</classname>
  60     and <classname>condition_variable_any</classname>.
  61   </para>
  62
  63   <para>
  64     In header <filename>thread</filename>,
  65     class <classname>thread</classname> and
  66     namespace <code>this_thread</code>.
  67   </para>
  68
  69   <para>
  70     In header <filename>future</filename>, class
  71     template <classname>future</classname> and class
  72     template <classname>shared_future</classname>, class
  73     template <classname>promise</classname>,
  74     and <classname>packaged_task</classname>.
  75   </para>
  76
  77   <para>
  78     Full API details.
  79   </para>
  80
  81   <!-- Doxygen XML: api/group__concurrency.xml -->
  82
  83 </sect1>
  84
  85 </chapter>