summaryrefslogtreecommitdiff
path: root/libstdc++-v3/doc/xml/manual/concurrency.xml
blob: e3dd9b9468a1b57fd6e8cb41a152d7acfc45d49f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" 
	 xml:id="std.concurrency" xreflabel="Concurrency">
<?dbhtml filename="concurrency.html"?>

<info><title>
  Concurrency
  <indexterm><primary>Concurrency</primary></indexterm>
</title>
  <keywordset>
    <keyword>
      ISO C++
    </keyword>
    <keyword>
      library
    </keyword>
    <keyword>
      mutex
    </keyword>
    <keyword>
      thread
    </keyword>
    <keyword>
      future
    </keyword>
    <keyword>
      condition_variable
    </keyword>
  </keywordset>
</info>



<para>
  Facilities for concurrent operation, and control thereof.
</para>


<!-- Sect1 01 : API -->
<section xml:id="std.concurrency.api"><info><title>API Reference</title></info>
  

  <para>
    All items are declared in one of four standard header files.
  </para>

  <para>
    In header <filename>mutex</filename>, class
    template <classname>mutex</classname> and variants,
    class <classname>once_flag</classname>, and class
    template <classname>unique_lock</classname>.
  </para>

  <para>
    In header <filename>condition_variable</filename>,
    classes <classname>condition_variable</classname>
    and <classname>condition_variable_any</classname>.
  </para>

  <para>
    In header <filename>thread</filename>,
    class <classname>thread</classname> and
    namespace <code>this_thread</code>.
  </para>

  <para>
    In header <filename>future</filename>, class
    template <classname>future</classname> and class
    template <classname>shared_future</classname>, class
    template <classname>promise</classname>,
    and <classname>packaged_task</classname>.
  </para>

  <para>
    Full API details.
  </para>

  <!-- Doxygen XML: api/group__concurrency.xml -->

</section>

</chapter>