<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>libstdc++: Mutexes</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(initResizable); /* @license-end */</script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">libstdc++ </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(function(){initNavTree('a01498.html','');}); /* @license-end */ </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#func-members">Functions</a> | <a href="#var-members">Variables</a> </div> <div class="headertitle"> <div class="title">Mutexes<div class="ingroups"><a class="el" href="a01468.html">Concurrency</a></div></div> </div> </div><!--header--> <div class="contents"> <div class="dynheader"> Collaboration diagram for Mutexes:</div> <div class="dyncontent"> <center><table><tr><td><div class="center"><iframe scrolling="no" frameborder="0" src="a01498.svg" width="219" height="35"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe> </div> </td></tr></table></center> </div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a07167.html">std::adopt_lock_t</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a07159.html">std::defer_lock_t</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a07171.html">std::lock_guard< _Mutex ></a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a07155.html">std::mutex</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a07163.html">std::try_to_lock_t</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a07175.html">std::unique_lock< _Mutex ></a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:gac58580a65df691769770684cc985719d"><td class="memTemplParams" colspan="2">template<typename _Mutex > </td></tr> <tr class="memitem:gac58580a65df691769770684cc985719d"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a01498.html#gac58580a65df691769770684cc985719d">std::swap</a> (<a class="el" href="a07175.html">unique_lock</a>< _Mutex > &__x, <a class="el" href="a07175.html">unique_lock</a>< _Mutex > &__y) noexcept</td></tr> <tr class="separator:gac58580a65df691769770684cc985719d"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a> Variables</h2></td></tr> <tr class="memitem:ga742a9b4798379cd99d03bbf298d3685c"><td class="memItemLeft" align="right" valign="top">_GLIBCXX17_INLINE constexpr <a class="el" href="a07167.html">adopt_lock_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01498.html#ga742a9b4798379cd99d03bbf298d3685c">std::adopt_lock</a></td></tr> <tr class="separator:ga742a9b4798379cd99d03bbf298d3685c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga70a73adf8c062ea682cd99580d0a39be"><td class="memItemLeft" align="right" valign="top">_GLIBCXX17_INLINE constexpr <a class="el" href="a07159.html">defer_lock_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01498.html#ga70a73adf8c062ea682cd99580d0a39be">std::defer_lock</a></td></tr> <tr class="separator:ga70a73adf8c062ea682cd99580d0a39be"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga05e641e1ecba98edb6fa4714a6c03e0d"><td class="memItemLeft" align="right" valign="top">_GLIBCXX17_INLINE constexpr <a class="el" href="a07163.html">try_to_lock_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01498.html#ga05e641e1ecba98edb6fa4714a6c03e0d">std::try_to_lock</a></td></tr> <tr class="separator:ga05e641e1ecba98edb6fa4714a6c03e0d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga0d3de8f7ff80877e53d25ca9057e1c0f"><td class="memTemplParams" colspan="2">template<typename _Mutex > </td></tr> <tr class="memitem:ga0d3de8f7ff80877e53d25ca9057e1c0f"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a01498.html#ga0d3de8f7ff80877e53d25ca9057e1c0f">std::swap</a> (<a class="el" href="a02779.html">shared_lock</a>< _Mutex > &__x, <a class="el" href="a02779.html">shared_lock</a>< _Mutex > &__y) noexcept</td></tr> <tr class="separator:ga0d3de8f7ff80877e53d25ca9057e1c0f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga00b5fb3f3bf333cc396bd38d3b069d85"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a01498.html#ga00b5fb3f3bf333cc396bd38d3b069d85">__cpp_lib_shared_timed_mutex</a></td></tr> <tr class="separator:ga00b5fb3f3bf333cc396bd38d3b069d85"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gab3c86906b8d29085ce9876aa6baab8e7"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="a01498.html#gab3c86906b8d29085ce9876aa6baab8e7">std::__shared_timed_mutex_base</a> = <a class="el" href="a02771.html">__shared_mutex_cv</a></td></tr> <tr class="separator:gab3c86906b8d29085ce9876aa6baab8e7"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>Classes for mutex support. </p> <h2 class="groupheader">Macro Definition Documentation</h2> <a id="ga00b5fb3f3bf333cc396bd38d3b069d85"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga00b5fb3f3bf333cc396bd38d3b069d85">◆ </a></span>__cpp_lib_shared_timed_mutex</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define __cpp_lib_shared_timed_mutex</td> </tr> </table> </div><div class="memdoc"> <p>Swap specialization for shared_lock. </p> <p class="definition">Definition at line <a class="el" href="a00137_source.html#l00057">57</a> of file <a class="el" href="a00137_source.html">shared_mutex</a>.</p> </div> </div> <h2 class="groupheader">Typedef Documentation</h2> <a id="gab3c86906b8d29085ce9876aa6baab8e7"></a> <h2 class="memtitle"><span class="permalink"><a href="#gab3c86906b8d29085ce9876aa6baab8e7">◆ </a></span>__shared_timed_mutex_base</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">using <a class="el" href="a01498.html#gab3c86906b8d29085ce9876aa6baab8e7">std::__shared_timed_mutex_base</a> = typedef <a class="el" href="a02771.html">__shared_mutex_cv</a></td> </tr> </table> </div><div class="memdoc"> <p>Swap specialization for shared_lock. </p> <p class="definition">Definition at line <a class="el" href="a00137_source.html#l00355">355</a> of file <a class="el" href="a00137_source.html">shared_mutex</a>.</p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a id="gac58580a65df691769770684cc985719d"></a> <h2 class="memtitle"><span class="permalink"><a href="#gac58580a65df691769770684cc985719d">◆ </a></span>swap() <span class="overload">[1/2]</span></h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Mutex > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void std::swap </td> <td>(</td> <td class="paramtype"><a class="el" href="a07175.html">unique_lock</a>< _Mutex > & </td> <td class="paramname"><em>__x</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a07175.html">unique_lock</a>< _Mutex > & </td> <td class="paramname"><em>__y</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Swap overload for unique_lock objects. </p> <p class="definition">Definition at line <a class="el" href="a00524_source.html#l00363">363</a> of file <a class="el" href="a00524_source.html">std_mutex.h</a>.</p> </div> </div> <a id="ga0d3de8f7ff80877e53d25ca9057e1c0f"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga0d3de8f7ff80877e53d25ca9057e1c0f">◆ </a></span>swap() <span class="overload">[2/2]</span></h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Mutex > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void std::swap </td> <td>(</td> <td class="paramtype"><a class="el" href="a02779.html">shared_lock</a>< _Mutex > & </td> <td class="paramname"><em>__x</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a02779.html">shared_lock</a>< _Mutex > & </td> <td class="paramname"><em>__y</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">noexcept</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Swap specialization for shared_lock. </p> <p class="definition">Definition at line <a class="el" href="a00137_source.html#l00676">676</a> of file <a class="el" href="a00137_source.html">shared_mutex</a>.</p> </div> </div> <h2 class="groupheader">Variable Documentation</h2> <a id="ga742a9b4798379cd99d03bbf298d3685c"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga742a9b4798379cd99d03bbf298d3685c">◆ </a></span>adopt_lock</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">_GLIBCXX17_INLINE constexpr <a class="el" href="a07167.html">adopt_lock_t</a> std::adopt_lock</td> </tr> </table> </div><div class="memdoc"> <p>Tag used to make a scoped lock take ownership of a locked mutex. </p> <p class="definition">Definition at line <a class="el" href="a00524_source.html#l00148">148</a> of file <a class="el" href="a00524_source.html">std_mutex.h</a>.</p> </div> </div> <a id="ga70a73adf8c062ea682cd99580d0a39be"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga70a73adf8c062ea682cd99580d0a39be">◆ </a></span>defer_lock</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">_GLIBCXX17_INLINE constexpr <a class="el" href="a07159.html">defer_lock_t</a> std::defer_lock</td> </tr> </table> </div><div class="memdoc"> <p>Tag used to prevent a scoped lock from acquiring ownership of a mutex. </p> <p class="definition">Definition at line <a class="el" href="a00524_source.html#l00142">142</a> of file <a class="el" href="a00524_source.html">std_mutex.h</a>.</p> </div> </div> <a id="ga05e641e1ecba98edb6fa4714a6c03e0d"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga05e641e1ecba98edb6fa4714a6c03e0d">◆ </a></span>try_to_lock</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">_GLIBCXX17_INLINE constexpr <a class="el" href="a07163.html">try_to_lock_t</a> std::try_to_lock</td> </tr> </table> </div><div class="memdoc"> <p>Tag used to prevent a scoped lock from blocking if a mutex is locked. </p> <p class="definition">Definition at line <a class="el" href="a00524_source.html#l00145">145</a> of file <a class="el" href="a00524_source.html">std_mutex.h</a>.</p> </div> </div> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> </ul> </div> </body> </html>