| <!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.17"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>mxnet: dmlc::ManualEvent Class Reference</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="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></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">mxnet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.17 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespacedmlc.html">dmlc</a></li><li class="navelem"><a class="el" href="classdmlc_1_1ManualEvent.html">ManualEvent</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classdmlc_1_1ManualEvent-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">dmlc::ManualEvent Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Simple manual-reset event gate which remains open after signalled. |
| <a href="classdmlc_1_1ManualEvent.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="thread__group_8h_source.html">thread_group.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for dmlc::ManualEvent:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classdmlc_1_1ManualEvent__coll__graph.png" border="0" usemap="#dmlc_1_1ManualEvent_coll__map" alt="Collaboration graph"/></div> |
| <!-- MAP 0 --> |
| </div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a9f1f6aefdf6df4f3b27845234f598583"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ManualEvent.html#a9f1f6aefdf6df4f3b27845234f598583">ManualEvent</a> ()</td></tr> |
| <tr class="separator:a9f1f6aefdf6df4f3b27845234f598583"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a24af45c7c96d8b9421ed3337c5def886"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ManualEvent.html#a24af45c7c96d8b9421ed3337c5def886">wait</a> ()</td></tr> |
| <tr class="memdesc:a24af45c7c96d8b9421ed3337c5def886"><td class="mdescLeft"> </td><td class="mdescRight">Wait for the object to become signaled. If the object is already in the signaled state and <a class="el" href="classdmlc_1_1ManualEvent.html#ad1c15c34d3b237dd878aaa9f6ca31f16" title="Manually reset this object's state to unsignaled (wait() will block)">reset()</a> has not been called, then no wait will occur. <a href="classdmlc_1_1ManualEvent.html#a24af45c7c96d8b9421ed3337c5def886">More...</a><br /></td></tr> |
| <tr class="separator:a24af45c7c96d8b9421ed3337c5def886"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aabdf6964cb72222e04fecfd9ffb9875e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ManualEvent.html#aabdf6964cb72222e04fecfd9ffb9875e">signal</a> ()</td></tr> |
| <tr class="memdesc:aabdf6964cb72222e04fecfd9ffb9875e"><td class="mdescLeft"> </td><td class="mdescRight">Set this object's state to signaled (<a class="el" href="classdmlc_1_1ManualEvent.html#a24af45c7c96d8b9421ed3337c5def886" title="Wait for the object to become signaled. If the object is already in the signaled state and reset() ha...">wait()</a> will release or pass through) <a href="classdmlc_1_1ManualEvent.html#aabdf6964cb72222e04fecfd9ffb9875e">More...</a><br /></td></tr> |
| <tr class="separator:aabdf6964cb72222e04fecfd9ffb9875e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad1c15c34d3b237dd878aaa9f6ca31f16"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ManualEvent.html#ad1c15c34d3b237dd878aaa9f6ca31f16">reset</a> ()</td></tr> |
| <tr class="memdesc:ad1c15c34d3b237dd878aaa9f6ca31f16"><td class="mdescLeft"> </td><td class="mdescRight">Manually reset this object's state to unsignaled (<a class="el" href="classdmlc_1_1ManualEvent.html#a24af45c7c96d8b9421ed3337c5def886" title="Wait for the object to become signaled. If the object is already in the signaled state and reset() ha...">wait()</a> will block) <a href="classdmlc_1_1ManualEvent.html#ad1c15c34d3b237dd878aaa9f6ca31f16">More...</a><br /></td></tr> |
| <tr class="separator:ad1c15c34d3b237dd878aaa9f6ca31f16"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Simple manual-reset event gate which remains open after signalled. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a9f1f6aefdf6df4f3b27845234f598583"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9f1f6aefdf6df4f3b27845234f598583">◆ </a></span>ManualEvent()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">dmlc::ManualEvent::ManualEvent </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ad1c15c34d3b237dd878aaa9f6ca31f16"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad1c15c34d3b237dd878aaa9f6ca31f16">◆ </a></span>reset()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void dmlc::ManualEvent::reset </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Manually reset this object's state to unsignaled (<a class="el" href="classdmlc_1_1ManualEvent.html#a24af45c7c96d8b9421ed3337c5def886" title="Wait for the object to become signaled. If the object is already in the signaled state and reset() ha...">wait()</a> will block) </p> |
| |
| </div> |
| </div> |
| <a id="aabdf6964cb72222e04fecfd9ffb9875e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aabdf6964cb72222e04fecfd9ffb9875e">◆ </a></span>signal()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void dmlc::ManualEvent::signal </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set this object's state to signaled (<a class="el" href="classdmlc_1_1ManualEvent.html#a24af45c7c96d8b9421ed3337c5def886" title="Wait for the object to become signaled. If the object is already in the signaled state and reset() ha...">wait()</a> will release or pass through) </p> |
| |
| </div> |
| </div> |
| <a id="a24af45c7c96d8b9421ed3337c5def886"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a24af45c7c96d8b9421ed3337c5def886">◆ </a></span>wait()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void dmlc::ManualEvent::wait </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Wait for the object to become signaled. If the object is already in the signaled state and <a class="el" href="classdmlc_1_1ManualEvent.html#ad1c15c34d3b237dd878aaa9f6ca31f16" title="Manually reset this object's state to unsignaled (wait() will block)">reset()</a> has not been called, then no wait will occur. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/work/mxnet/3rdparty/dmlc-core/include/dmlc/<a class="el" href="thread__group_8h_source.html">thread_group.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 03:47:40 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |
