<!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_job_manager Class 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('classgc__job__manager.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<h1>gc_job_manager Class Reference<div class="ingroups"><a class="el" href="group__gcell.html">gcell: Cell Broadband Engine SPE Scheduler & RPC Mechanism</a></div></h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="gc_job_manager" -->
<p>Abstract class that manages SPE jobs.There is typically a single instance derived from this class. It is safe to call its methods from any thread.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gc__job__manager_8h_source.html">gc_job_manager.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gc_job_manager:</div>
<div class="dyncontent">
<div class="center"><img src="classgc__job__manager__inherit__graph.png" border="0" usemap="#gc__job__manager_inherit__map" alt="Inheritance graph"/></div>
<map name="gc__job__manager_inherit__map" id="gc__job__manager_inherit__map">
<area shape="rect" id="node3" href="classgc__job__manager__impl.html" title="Concrete class that manages SPE jobs." alt="" coords="5,83,152,112"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgc__job__manager-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__job__manager.html#a55d6e5f2dd1035a1d0d915c3d890916f">gc_job_manager</a> (const <a class="el" href="structgc__jm__options.html">gc_jm_options</a> *options=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__job__manager.html#a40094f709ede2264ec1df985e996a411">~gc_job_manager</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__job__manager.html#a12ba6187460071d427305809cae8a5ba">shutdown</a> ()=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__job__manager.html#a50d8e2f20b58d1c6743d86277664cad2">nspes</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return number of SPE's currently allocated to job manager. <a href="#a50d8e2f20b58d1c6743d86277664cad2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structgc__job__desc.html">gc_job_desc</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__job__manager.html#a22f39fc07b55782205b914555b8cb10a">alloc_job_desc</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to a properly aligned job descriptor, or throws <a class="el" href="classgc__bad__alloc.html">gc_bad_alloc</a> if there are none available. <a href="#a22f39fc07b55782205b914555b8cb10a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__job__manager.html#a0aeeb7c3b20089adcd521179a33e326d">free_job_desc</a> (<a class="el" href="structgc__job__desc.html">gc_job_desc</a> *jd)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__job__manager.html#a050c7cc1ed51f2ff5a6e41541c55cf29">submit_job</a> (<a class="el" href="structgc__job__desc.html">gc_job_desc</a> *jd)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Submit a job for asynchronous processing on an SPE. <a href="#a050c7cc1ed51f2ff5a6e41541c55cf29"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__job__manager.html#ad323d06be028cd5f4848cbd7451b2114">wait_job</a> (<a class="el" href="structgc__job__desc.html">gc_job_desc</a> *jd)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wait for job to complete. <a href="#ad323d06be028cd5f4848cbd7451b2114"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__job__manager.html#a3f202d807a08d7756112388ce9fd03ff">wait_jobs</a> (unsigned int njobs, <a class="el" href="structgc__job__desc.html">gc_job_desc</a> *jd[], <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> done[], <a class="el" href="gc__job__manager_8h.html#ab5ff7bcddb7471da0c9f1f0d7dbe038c">gc_wait_mode</a> mode)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">wait for 1 or more jobs to complete. <a href="#a3f202d807a08d7756112388ce9fd03ff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__job__manager.html#acd5c7de0370f3186ae467f8db24ca94d">ea_args_maxsize</a> ()=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="gc__job__desc_8h.html#a26e60e5aaade61f7c333ee636940a658">gc_proc_id_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__job__manager.html#aebe49e58ce5ffc139b133bd5c1d1675b">lookup_proc</a> (const std::string &proc_name)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classstd_1_1vector.html">std::vector</a>< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__job__manager.html#a62257a6f86bf862494054a1a57cb128c">proc_names</a> ()=0</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__job__manager.html#a4df28764e574674ae33ab149982fa0da">set_singleton</a> (<a class="el" href="classboost_1_1shared__ptr.html">gc_job_manager_sptr</a> mgr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the singleton <a class="el" href="classgc__job__manager.html" title="Abstract class that manages SPE jobs.There is typically a single instance derived from this class...">gc_job_manager</a> instance. <a href="#a4df28764e574674ae33ab149982fa0da"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classboost_1_1shared__ptr.html">gc_job_manager_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__job__manager.html#a02b46ba7fd4fbd19fa18a3e2dd500a62">singleton</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the singleton <a class="el" href="classgc__job__manager.html" title="Abstract class that manages SPE jobs.There is typically a single instance derived from this class...">gc_job_manager</a> instance. <a href="#a02b46ba7fd4fbd19fa18a3e2dd500a62"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classboost_1_1shared__ptr.html">gc_job_desc_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__job__manager.html#afdbb9fd2337021451ae1f646b0495bec">alloc_job_desc</a> (<a class="el" href="classboost_1_1shared__ptr.html">gc_job_manager_sptr</a> mgr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">allocate a job descriptor and return a <a class="el" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr</a> to it. <a href="#afdbb9fd2337021451ae1f646b0495bec"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract class that manages SPE jobs.</p>
<p>There is typically a single instance derived from this class. It is safe to call its methods from any thread. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a55d6e5f2dd1035a1d0d915c3d890916f"></a><!-- doxytag: member="gc_job_manager::gc_job_manager" ref="a55d6e5f2dd1035a1d0d915c3d890916f" args="(const gc_jm_options *options=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gc_job_manager::gc_job_manager </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgc__jm__options.html">gc_jm_options</a> * </td>
<td class="paramname"><em>options</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a40094f709ede2264ec1df985e996a411"></a><!-- doxytag: member="gc_job_manager::~gc_job_manager" ref="a40094f709ede2264ec1df985e996a411" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual gc_job_manager::~gc_job_manager </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a22f39fc07b55782205b914555b8cb10a"></a><!-- doxytag: member="gc_job_manager::alloc_job_desc" ref="a22f39fc07b55782205b914555b8cb10a" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structgc__job__desc.html">gc_job_desc</a>* gc_job_manager::alloc_job_desc </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a pointer to a properly aligned job descriptor, or throws <a class="el" href="classgc__bad__alloc.html">gc_bad_alloc</a> if there are none available. </p>
<p>Implemented in <a class="el" href="classgc__job__manager__impl.html#a228e1efb2b9b5deb8687b9cd57c00cb3">gc_job_manager_impl</a>.</p>
</div>
</div>
<a class="anchor" id="afdbb9fd2337021451ae1f646b0495bec"></a><!-- doxytag: member="gc_job_manager::alloc_job_desc" ref="afdbb9fd2337021451ae1f646b0495bec" args="(gc_job_manager_sptr mgr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classboost_1_1shared__ptr.html">gc_job_desc_sptr</a> gc_job_manager::alloc_job_desc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gc_job_manager_sptr</a> </td>
<td class="paramname"><em>mgr</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>allocate a job descriptor and return a <a class="el" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr</a> to it. </p>
</div>
</div>
<a class="anchor" id="acd5c7de0370f3186ae467f8db24ca94d"></a><!-- doxytag: member="gc_job_manager::ea_args_maxsize" ref="acd5c7de0370f3186ae467f8db24ca94d" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int gc_job_manager::ea_args_maxsize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the maximum number of bytes of EA arguments that may be copied to or from the SPE in a single job. The limit applies independently to the "get" and "put" args. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__gcell.html#ga1437283a479e08d5d674007709805657" title=""job description" that is DMA'd to/from the SPE.">gc_job_desc_t</a>, <a class="el" href="gc__job__desc_8h.html#aaf241ad9e3f4fabafcbecbbea760298a">gc_job_ea_args_t</a> </dd></dl>
<p>Implemented in <a class="el" href="classgc__job__manager__impl.html#ad5076a7ebbef03a29f7dbfb15c2b7077">gc_job_manager_impl</a>.</p>
</div>
</div>
<a class="anchor" id="a0aeeb7c3b20089adcd521179a33e326d"></a><!-- doxytag: member="gc_job_manager::free_job_desc" ref="a0aeeb7c3b20089adcd521179a33e326d" args="(gc_job_desc *jd)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void gc_job_manager::free_job_desc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgc__job__desc.html">gc_job_desc</a> * </td>
<td class="paramname"><em>jd</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implemented in <a class="el" href="classgc__job__manager__impl.html#a597a24f5aee6e49b6293f068915ade29">gc_job_manager_impl</a>.</p>
</div>
</div>
<a class="anchor" id="aebe49e58ce5ffc139b133bd5c1d1675b"></a><!-- doxytag: member="gc_job_manager::lookup_proc" ref="aebe49e58ce5ffc139b133bd5c1d1675b" args="(const std::string &proc_name)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="gc__job__desc_8h.html#a26e60e5aaade61f7c333ee636940a658">gc_proc_id_t</a> gc_job_manager::lookup_proc </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>proc_name</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return gc_proc_id_t associated with spu procedure <code>proc_name</code> if one exists, otherwise throws <a class="el" href="classgc__unknown__proc.html">gc_unknown_proc</a>. </p>
<p>Implemented in <a class="el" href="classgc__job__manager__impl.html#ad997884dd828c691e5505f85d9760271">gc_job_manager_impl</a>.</p>
</div>
</div>
<a class="anchor" id="a50d8e2f20b58d1c6743d86277664cad2"></a><!-- doxytag: member="gc_job_manager::nspes" ref="a50d8e2f20b58d1c6743d86277664cad2" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int gc_job_manager::nspes </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return number of SPE's currently allocated to job manager. </p>
<p>Implemented in <a class="el" href="classgc__job__manager__impl.html#ac0615bca7876460eb0f5e8dd449a4fb0">gc_job_manager_impl</a>.</p>
</div>
</div>
<a class="anchor" id="a62257a6f86bf862494054a1a57cb128c"></a><!-- doxytag: member="gc_job_manager::proc_names" ref="a62257a6f86bf862494054a1a57cb128c" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classstd_1_1vector.html">std::vector</a><std::string> gc_job_manager::proc_names </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a vector of all known spu procedure names. </p>
<p>Implemented in <a class="el" href="classgc__job__manager__impl.html#aa2933ca9cfc5623d9041576de73181f4">gc_job_manager_impl</a>.</p>
</div>
</div>
<a class="anchor" id="a4df28764e574674ae33ab149982fa0da"></a><!-- doxytag: member="gc_job_manager::set_singleton" ref="a4df28764e574674ae33ab149982fa0da" args="(gc_job_manager_sptr mgr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void gc_job_manager::set_singleton </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gc_job_manager_sptr</a> </td>
<td class="paramname"><em>mgr</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the singleton <a class="el" href="classgc__job__manager.html" title="Abstract class that manages SPE jobs.There is typically a single instance derived from this class...">gc_job_manager</a> instance. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">mgr</td><td>is the job manager instance.</td></tr>
</table>
</dd>
</dl>
<p>The singleton is weakly held, thus the caller must maintain a reference to the mgr for the duration. (If we held the manager strongly, the destructor would never be called, and the resources (SPEs) would not be returned.) Bottom line: the caller is responsible for life-time management. </p>
</div>
</div>
<a class="anchor" id="a12ba6187460071d427305809cae8a5ba"></a><!-- doxytag: member="gc_job_manager::shutdown" ref="a12ba6187460071d427305809cae8a5ba" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> gc_job_manager::shutdown </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stop accepting new jobs. Wait for existing jobs to complete. Return all managed SPE's to the system. </p>
<p>Implemented in <a class="el" href="classgc__job__manager__impl.html#a16166dba92ae5e68d7d45778490585b7">gc_job_manager_impl</a>.</p>
</div>
</div>
<a class="anchor" id="a02b46ba7fd4fbd19fa18a3e2dd500a62"></a><!-- doxytag: member="gc_job_manager::singleton" ref="a02b46ba7fd4fbd19fa18a3e2dd500a62" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classboost_1_1shared__ptr.html">gc_job_manager_sptr</a> gc_job_manager::singleton </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the singleton <a class="el" href="classgc__job__manager.html" title="Abstract class that manages SPE jobs.There is typically a single instance derived from this class...">gc_job_manager</a> instance. </p>
<p>Returns the singleton <a class="el" href="classgc__job__manager.html" title="Abstract class that manages SPE jobs.There is typically a single instance derived from this class...">gc_job_manager</a> instance or raises boost::bad_weak_ptr if the singleton is empty. </p>
</div>
</div>
<a class="anchor" id="a050c7cc1ed51f2ff5a6e41541c55cf29"></a><!-- doxytag: member="gc_job_manager::submit_job" ref="a050c7cc1ed51f2ff5a6e41541c55cf29" args="(gc_job_desc *jd)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> gc_job_manager::submit_job </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgc__job__desc.html">gc_job_desc</a> * </td>
<td class="paramname"><em>jd</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Submit a job for asynchronous processing on an SPE. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">jd</td><td>pointer to job description</td></tr>
</table>
</dd>
</dl>
<p>The caller must not read or write the job description or any of the memory associated with any indirect arguments until after calling wait_job.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true iff the job was successfully enqueued. If submit_job returns false, check jd->status for additional info. </dd></dl>
<p>Implemented in <a class="el" href="classgc__job__manager__impl.html#a4e1c1655e4a97433f870c5276a95e5e4">gc_job_manager_impl</a>.</p>
</div>
</div>
<a class="anchor" id="ad323d06be028cd5f4848cbd7451b2114"></a><!-- doxytag: member="gc_job_manager::wait_job" ref="ad323d06be028cd5f4848cbd7451b2114" args="(gc_job_desc *jd)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> gc_job_manager::wait_job </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgc__job__desc.html">gc_job_desc</a> * </td>
<td class="paramname"><em>jd</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Wait for job to complete. </p>
<p>A thread may only wait for jobs which it submitted.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if sucessful, else false. </dd></dl>
<p>Implemented in <a class="el" href="classgc__job__manager__impl.html#a8793896a991f22526528db5c5fd6c266">gc_job_manager_impl</a>.</p>
</div>
</div>
<a class="anchor" id="a3f202d807a08d7756112388ce9fd03ff"></a><!-- doxytag: member="gc_job_manager::wait_jobs" ref="a3f202d807a08d7756112388ce9fd03ff" args="(unsigned int njobs, gc_job_desc *jd[], bool done[], gc_wait_mode mode)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int gc_job_manager::wait_jobs </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>njobs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structgc__job__desc.html">gc_job_desc</a> * </td>
<td class="paramname"><em>jd</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td>
<td class="paramname"><em>done</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="gc__job__manager_8h.html#ab5ff7bcddb7471da0c9f1f0d7dbe038c">gc_wait_mode</a> </td>
<td class="paramname"><em>mode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>wait for 1 or more jobs to complete. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">njobs</td><td>is the length of arrays <code>jd</code> and <code>done</code>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">jd</td><td>are the jobs that are to be waited for. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">done</td><td>indicates whether the corresponding job is complete. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>indicates whether to wait for ALL or ANY of the jobs in <code>jd</code> to complete.</td></tr>
</table>
</dd>
</dl>
<p>A thread may only wait for jobs which it submitted.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of jobs completed, or -1 if error. The caller must examine the status field of each job to confirm successful completion of the job. </dd></dl>
<p>Implemented in <a class="el" href="classgc__job__manager__impl.html#abba55d25693227d82ce4afa74b6a1fcb">gc_job_manager_impl</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gc__job__manager_8h_source.html">gc_job_manager.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classgc__job__manager.html">gc_job_manager</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>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
522
