<!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"/> <title>GNU Radio 3.2.2 C++ API: gc_jd_queue.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.3 --> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">GNU Radio 3.2.2 C++ API</div> </td> </tr> </tbody> </table> </div> </div> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('spu_2gc__jd__queue_8h.html',''); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#enum-members">Enumerations</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <h1>gc_jd_queue.h File Reference</h1> </div> </div> <div class="contents"> <div class="textblock"><code>#include <gcell/gc_jd_queue_data.h></code><br/> </div><div class="textblock"><div class="dynheader"> Include dependency graph for spu/gc_jd_queue.h:</div> <div class="dyncontent"> <div class="center"><img src="spu_2gc__jd__queue_8h__incl.png" border="0" usemap="#gc__jd__queue_8h" alt=""/></div> <map name="gc__jd__queue_8h" id="gc__jd__queue_8h"> </map> </div> </div> <p><a href="spu_2gc__jd__queue_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="enum-members"></a> Enumerations</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="spu_2gc__jd__queue_8h.html#a8d4fc0afb98cd0114353edb6310ec9e4">gc_dequeue_status_t</a> { <a class="el" href="spu_2gc__jd__queue_8h.html#a8d4fc0afb98cd0114353edb6310ec9e4ae3bf3ce1f2b62be317d2d8c4a77c0337">GCQ_OK</a>, <a class="el" href="spu_2gc__jd__queue_8h.html#a8d4fc0afb98cd0114353edb6310ec9e4aa94c1fad8db3b92efd219f902833c8dd">GCQ_EMPTY</a>, <a class="el" href="spu_2gc__jd__queue_8h.html#a8d4fc0afb98cd0114353edb6310ec9e4a2627b62410f8f9d6e80764b06a80371c">GCQ_LOCKED</a> }</td></tr> <tr><td colspan="2"><h2><a name="func-members"></a> Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="spu_2gc__jd__queue_8h.html#a8d4fc0afb98cd0114353edb6310ec9e4">gc_dequeue_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="spu_2gc__jd__queue_8h.html#a8b09b930d80d97832aa08e0153e47fba">gc_jd_queue_dequeue</a> (<a class="el" href="gc__types_8h.html#affc43a8e5ab8551e7361f8ce8521c34d">gc_eaddr_t</a> q, <a class="el" href="gc__types_8h.html#affc43a8e5ab8551e7361f8ce8521c34d">gc_eaddr_t</a> *item_ea, int jd_tag, <a class="el" href="structgc__job__desc.html">gc_job_desc_t</a> *item)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Remove and return item at head of queue. <a href="#a8b09b930d80d97832aa08e0153e47fba"></a><br/></td></tr> </table> <hr/><h2>Enumeration Type Documentation</h2> <a class="anchor" id="a8d4fc0afb98cd0114353edb6310ec9e4"></a><!-- doxytag: member="spu/gc_jd_queue.h::gc_dequeue_status_t" ref="a8d4fc0afb98cd0114353edb6310ec9e4" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="spu_2gc__jd__queue_8h.html#a8d4fc0afb98cd0114353edb6310ec9e4">gc_dequeue_status_t</a></td> </tr> </table> </div> <div class="memdoc"> <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><em><a class="anchor" id="a8d4fc0afb98cd0114353edb6310ec9e4ae3bf3ce1f2b62be317d2d8c4a77c0337"></a><!-- doxytag: member="GCQ_OK" ref="a8d4fc0afb98cd0114353edb6310ec9e4ae3bf3ce1f2b62be317d2d8c4a77c0337" args="" -->GCQ_OK</em> </td><td> </td></tr> <tr><td valign="top"><em><a class="anchor" id="a8d4fc0afb98cd0114353edb6310ec9e4aa94c1fad8db3b92efd219f902833c8dd"></a><!-- doxytag: member="GCQ_EMPTY" ref="a8d4fc0afb98cd0114353edb6310ec9e4aa94c1fad8db3b92efd219f902833c8dd" args="" -->GCQ_EMPTY</em> </td><td> </td></tr> <tr><td valign="top"><em><a class="anchor" id="a8d4fc0afb98cd0114353edb6310ec9e4a2627b62410f8f9d6e80764b06a80371c"></a><!-- doxytag: member="GCQ_LOCKED" ref="a8d4fc0afb98cd0114353edb6310ec9e4a2627b62410f8f9d6e80764b06a80371c" args="" -->GCQ_LOCKED</em> </td><td> </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Function Documentation</h2> <a class="anchor" id="a8b09b930d80d97832aa08e0153e47fba"></a><!-- doxytag: member="spu/gc_jd_queue.h::gc_jd_queue_dequeue" ref="a8b09b930d80d97832aa08e0153e47fba" args="(gc_eaddr_t q, gc_eaddr_t *item_ea, int jd_tag, gc_job_desc_t *item)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="spu_2gc__jd__queue_8h.html#a8d4fc0afb98cd0114353edb6310ec9e4">gc_dequeue_status_t</a> gc_jd_queue_dequeue </td> <td>(</td> <td class="paramtype"><a class="el" href="gc__types_8h.html#affc43a8e5ab8551e7361f8ce8521c34d">gc_eaddr_t</a> </td> <td class="paramname"><em>q</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="gc__types_8h.html#affc43a8e5ab8551e7361f8ce8521c34d">gc_eaddr_t</a> * </td> <td class="paramname"><em>item_ea</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>jd_tag</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="structgc__job__desc.html">gc_job_desc_t</a> * </td> <td class="paramname"><em>item</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Remove and return item at head of queue. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">q</td><td>is EA address of queue structure. </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">item_ea</td><td>is EA address of item at head of queue. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">jd_tag</td><td>is the tag to use to get the LS copy of the item. </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">item</td><td>is local store copy of item at head of queue. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>false if the queue is empty, otherwise returns true and sets <code>item_ea</code> and DMA's job descriptor into <code>item</code> </dd></dl> <p>If return is not GCQ_OK, we're holding a lock-line reservation that covers the queue. </p> </div> </div> </div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="spu_2gc__jd__queue_8h.html">gc_jd_queue.h</a> </li> <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li> </ul> </div> </body> </html>