| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>mxnet: dmlc::ConcurrentBlockingQueue< T, type > Class Template 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.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </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_1ConcurrentBlockingQueue.html">ConcurrentBlockingQueue</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classdmlc_1_1ConcurrentBlockingQueue-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">dmlc::ConcurrentBlockingQueue< T, type > Class Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Cocurrent blocking queue. |
| <a href="classdmlc_1_1ConcurrentBlockingQueue.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="concurrency_8h_source.html">concurrency.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for dmlc::ConcurrentBlockingQueue< T, type >:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classdmlc_1_1ConcurrentBlockingQueue__coll__graph.png" border="0" usemap="#dmlc_1_1ConcurrentBlockingQueue_3_01T_00_01type_01_4_coll__map" alt="Collaboration graph"/></div> |
| <map name="dmlc_1_1ConcurrentBlockingQueue_3_01T_00_01type_01_4_coll__map" id="dmlc_1_1ConcurrentBlockingQueue_3_01T_00_01type_01_4_coll__map"> |
| </map> |
| </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:a835ab07cb02d61059eb1bb937fde3550"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ConcurrentBlockingQueue.html#a835ab07cb02d61059eb1bb937fde3550">ConcurrentBlockingQueue</a> ()</td></tr> |
| <tr class="separator:a835ab07cb02d61059eb1bb937fde3550"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2c7e415e3bc1fc3c43536f8f08041dea"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ConcurrentBlockingQueue.html#a2c7e415e3bc1fc3c43536f8f08041dea">~ConcurrentBlockingQueue</a> ()=default</td></tr> |
| <tr class="separator:a2c7e415e3bc1fc3c43536f8f08041dea"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7d462648c0dba8e495e1efaacff6a75a"><td class="memTemplParams" colspan="2">template<typename E > </td></tr> |
| <tr class="memitem:a7d462648c0dba8e495e1efaacff6a75a"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ConcurrentBlockingQueue.html#a7d462648c0dba8e495e1efaacff6a75a">Push</a> (E &&e, int priority=0)</td></tr> |
| <tr class="memdesc:a7d462648c0dba8e495e1efaacff6a75a"><td class="mdescLeft"> </td><td class="mdescRight">Push element to the end of the queue. <a href="#a7d462648c0dba8e495e1efaacff6a75a">More...</a><br /></td></tr> |
| <tr class="separator:a7d462648c0dba8e495e1efaacff6a75a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9ae71ca4d6890a788e162521afb446d8"><td class="memTemplParams" colspan="2">template<typename E > </td></tr> |
| <tr class="memitem:a9ae71ca4d6890a788e162521afb446d8"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ConcurrentBlockingQueue.html#a9ae71ca4d6890a788e162521afb446d8">PushFront</a> (E &&e, int priority=0)</td></tr> |
| <tr class="memdesc:a9ae71ca4d6890a788e162521afb446d8"><td class="mdescLeft"> </td><td class="mdescRight">Push element to the front of the queue. Only works for FIFO queue. For priority queue it is the same as Push. <a href="#a9ae71ca4d6890a788e162521afb446d8">More...</a><br /></td></tr> |
| <tr class="separator:a9ae71ca4d6890a788e162521afb446d8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afb8bbf0d5ec39d22b9a3d7c86a649c86"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ConcurrentBlockingQueue.html#afb8bbf0d5ec39d22b9a3d7c86a649c86">Pop</a> (T *rv)</td></tr> |
| <tr class="memdesc:afb8bbf0d5ec39d22b9a3d7c86a649c86"><td class="mdescLeft"> </td><td class="mdescRight">Pop element from the queue. <a href="#afb8bbf0d5ec39d22b9a3d7c86a649c86">More...</a><br /></td></tr> |
| <tr class="separator:afb8bbf0d5ec39d22b9a3d7c86a649c86"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aadedf3f04b1cacb7dd2b834d91447427"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ConcurrentBlockingQueue.html#aadedf3f04b1cacb7dd2b834d91447427">SignalForKill</a> ()</td></tr> |
| <tr class="memdesc:aadedf3f04b1cacb7dd2b834d91447427"><td class="mdescLeft"> </td><td class="mdescRight">Signal the queue for destruction. <a href="#aadedf3f04b1cacb7dd2b834d91447427">More...</a><br /></td></tr> |
| <tr class="separator:aadedf3f04b1cacb7dd2b834d91447427"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aadeb49c6b5bb73d6c5865cc053f5d2f3"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ConcurrentBlockingQueue.html#aadeb49c6b5bb73d6c5865cc053f5d2f3">Size</a> ()</td></tr> |
| <tr class="memdesc:aadeb49c6b5bb73d6c5865cc053f5d2f3"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the queue. <a href="#aadeb49c6b5bb73d6c5865cc053f5d2f3">More...</a><br /></td></tr> |
| <tr class="separator:aadeb49c6b5bb73d6c5865cc053f5d2f3"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><h3>template<typename T, ConcurrentQueueType type = ConcurrentQueueType::kFIFO><br /> |
| class dmlc::ConcurrentBlockingQueue< T, type ></h3> |
| |
| <p>Cocurrent blocking queue. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a835ab07cb02d61059eb1bb937fde3550"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a835ab07cb02d61059eb1bb937fde3550">◆ </a></span>ConcurrentBlockingQueue()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T , ConcurrentQueueType type> </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classdmlc_1_1ConcurrentBlockingQueue.html">dmlc::ConcurrentBlockingQueue</a>< T, type >::<a class="el" href="classdmlc_1_1ConcurrentBlockingQueue.html">ConcurrentBlockingQueue</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a2c7e415e3bc1fc3c43536f8f08041dea"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2c7e415e3bc1fc3c43536f8f08041dea">◆ </a></span>~ConcurrentBlockingQueue()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T , ConcurrentQueueType type = ConcurrentQueueType::kFIFO> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classdmlc_1_1ConcurrentBlockingQueue.html">dmlc::ConcurrentBlockingQueue</a>< T, type >::~<a class="el" href="classdmlc_1_1ConcurrentBlockingQueue.html">ConcurrentBlockingQueue</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">default</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="afb8bbf0d5ec39d22b9a3d7c86a649c86"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afb8bbf0d5ec39d22b9a3d7c86a649c86">◆ </a></span>Pop()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T , ConcurrentQueueType type> </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="classdmlc_1_1ConcurrentBlockingQueue.html">dmlc::ConcurrentBlockingQueue</a>< T, type >::Pop </td> |
| <td>(</td> |
| <td class="paramtype">T * </td> |
| <td class="paramname"><em>rv</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Pop element from the queue. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">rv</td><td>Element popped. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>On false, the queue is exiting.</dd></dl> |
| <p>The element will be copied or moved into the object passed in. </p> |
| |
| </div> |
| </div> |
| <a id="a7d462648c0dba8e495e1efaacff6a75a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7d462648c0dba8e495e1efaacff6a75a">◆ </a></span>Push()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T , ConcurrentQueueType type> </div> |
| <div class="memtemplate"> |
| template<typename E > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classdmlc_1_1ConcurrentBlockingQueue.html">dmlc::ConcurrentBlockingQueue</a>< T, type >::Push </td> |
| <td>(</td> |
| <td class="paramtype">E && </td> |
| <td class="paramname"><em>e</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>priority</em> = <code>0</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Push element to the end of the queue. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">e</td><td>Element to push into. </td></tr> |
| <tr><td class="paramname">priority</td><td>the priority of the element, only used for priority queue. The higher the priority is, the better. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">E</td><td>the element type</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>It will copy or move the element into the queue, depending on the type of the parameter. </p> |
| |
| </div> |
| </div> |
| <a id="a9ae71ca4d6890a788e162521afb446d8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9ae71ca4d6890a788e162521afb446d8">◆ </a></span>PushFront()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T , ConcurrentQueueType type> </div> |
| <div class="memtemplate"> |
| template<typename E > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classdmlc_1_1ConcurrentBlockingQueue.html">dmlc::ConcurrentBlockingQueue</a>< T, type >::PushFront </td> |
| <td>(</td> |
| <td class="paramtype">E && </td> |
| <td class="paramname"><em>e</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>priority</em> = <code>0</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Push element to the front of the queue. Only works for FIFO queue. For priority queue it is the same as Push. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">e</td><td>Element to push into. </td></tr> |
| <tr><td class="paramname">priority</td><td>the priority of the element, only used for priority queue. The higher the priority is, the better. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">E</td><td>the element type</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>It will copy or move the element into the queue, depending on the type of the parameter. </p> |
| |
| </div> |
| </div> |
| <a id="aadedf3f04b1cacb7dd2b834d91447427"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aadedf3f04b1cacb7dd2b834d91447427">◆ </a></span>SignalForKill()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T , ConcurrentQueueType type> </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classdmlc_1_1ConcurrentBlockingQueue.html">dmlc::ConcurrentBlockingQueue</a>< T, type >::SignalForKill </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Signal the queue for destruction. </p> |
| <p>After calling this method, all blocking pop call to the queue will return false. </p> |
| |
| </div> |
| </div> |
| <a id="aadeb49c6b5bb73d6c5865cc053f5d2f3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aadeb49c6b5bb73d6c5865cc053f5d2f3">◆ </a></span>Size()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T , ConcurrentQueueType type> </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">size_t <a class="el" href="classdmlc_1_1ConcurrentBlockingQueue.html">dmlc::ConcurrentBlockingQueue</a>< T, type >::Size </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the size of the queue. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The size of the queue. </dd></dl> |
| |
| </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="concurrency_8h_source.html">concurrency.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 00:58:43 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
