<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.7.3">
<compounddef id="classgc__job__manager" kind="class" prot="public">
<compoundname>gc_job_manager</compoundname>
<derivedcompoundref refid="classgc__job__manager__impl" prot="public" virt="non-virtual">gc_job_manager_impl</derivedcompoundref>
<includes refid="gc__job__manager_8h" local="no">gc_job_manager.h</includes>
<sectiondef kind="public-func">
<memberdef kind="function" id="classgc__job__manager_1a55d6e5f2dd1035a1d0d915c3d890916f" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>gc_job_manager::gc_job_manager</definition>
<argsstring>(const gc_jm_options *options=0)</argsstring>
<name>gc_job_manager</name>
<param>
<type>const <ref refid="structgc__jm__options" kindref="compound">gc_jm_options</ref> *</type>
<declname>options</declname>
<defval>0</defval>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="160"/>
</memberdef>
<memberdef kind="function" id="classgc__job__manager_1a40094f709ede2264ec1df985e996a411" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
<type></type>
<definition>virtual gc_job_manager::~gc_job_manager</definition>
<argsstring>()</argsstring>
<name>~gc_job_manager</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="162"/>
</memberdef>
<memberdef kind="function" id="classgc__job__manager_1a12ba6187460071d427305809cae8a5ba" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
<type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
<definition>virtual bool gc_job_manager::shutdown</definition>
<argsstring>()=0</argsstring>
<name>shutdown</name>
<reimplementedby refid="classgc__job__manager__impl_1a16166dba92ae5e68d7d45778490585b7">shutdown</reimplementedby>
<briefdescription>
</briefdescription>
<detaileddescription>
<para>Stop accepting new jobs. Wait for existing jobs to complete. Return all managed SPE's to the system. </para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="168"/>
</memberdef>
<memberdef kind="function" id="classgc__job__manager_1a50d8e2f20b58d1c6743d86277664cad2" prot="public" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
<type>int</type>
<definition>virtual int gc_job_manager::nspes</definition>
<argsstring>() const =0</argsstring>
<name>nspes</name>
<reimplementedby refid="classgc__job__manager__impl_1ac0615bca7876460eb0f5e8dd449a4fb0">nspes</reimplementedby>
<briefdescription>
<para>Return number of SPE's currently allocated to job manager. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="173"/>
</memberdef>
<memberdef kind="function" id="classgc__job__manager_1a22f39fc07b55782205b914555b8cb10a" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
<type><ref refid="structgc__job__desc" kindref="compound">gc_job_desc</ref> *</type>
<definition>virtual gc_job_desc* gc_job_manager::alloc_job_desc</definition>
<argsstring>()=0</argsstring>
<name>alloc_job_desc</name>
<reimplementedby refid="classgc__job__manager__impl_1a228e1efb2b9b5deb8687b9cd57c00cb3">alloc_job_desc</reimplementedby>
<briefdescription>
<para>Return a pointer to a properly aligned job descriptor, or throws <ref refid="classgc__bad__alloc" kindref="compound">gc_bad_alloc</ref> if there are none available. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="179"/>
</memberdef>
<memberdef kind="function" id="classgc__job__manager_1a0aeeb7c3b20089adcd521179a33e326d" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
<type>void</type>
<definition>virtual void gc_job_manager::free_job_desc</definition>
<argsstring>(gc_job_desc *jd)=0</argsstring>
<name>free_job_desc</name>
<reimplementedby refid="classgc__job__manager__impl_1a597a24f5aee6e49b6293f068915ade29">free_job_desc</reimplementedby>
<param>
<type><ref refid="structgc__job__desc" kindref="compound">gc_job_desc</ref> *</type>
<declname>jd</declname>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="186"/>
</memberdef>
<memberdef kind="function" id="classgc__job__manager_1a050c7cc1ed51f2ff5a6e41541c55cf29" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
<type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
<definition>virtual bool gc_job_manager::submit_job</definition>
<argsstring>(gc_job_desc *jd)=0</argsstring>
<name>submit_job</name>
<reimplementedby refid="classgc__job__manager__impl_1a4e1c1655e4a97433f870c5276a95e5e4">submit_job</reimplementedby>
<param>
<type><ref refid="structgc__job__desc" kindref="compound">gc_job_desc</ref> *</type>
<declname>jd</declname>
</param>
<briefdescription>
<para>Submit a job for asynchronous processing on an SPE. </para> </briefdescription>
<detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">jd</parametername>
</parameternamelist>
<parameterdescription>
<para>pointer to job description</para></parameterdescription>
</parameteritem>
</parameterlist>
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.</para><para><simplesect kind="return"><para>true iff the job was successfully enqueued. If submit_job returns false, check jd->status for additional info. </para></simplesect>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="200"/>
</memberdef>
<memberdef kind="function" id="classgc__job__manager_1ad323d06be028cd5f4848cbd7451b2114" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
<type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
<definition>virtual bool gc_job_manager::wait_job</definition>
<argsstring>(gc_job_desc *jd)=0</argsstring>
<name>wait_job</name>
<reimplementedby refid="classgc__job__manager__impl_1a8793896a991f22526528db5c5fd6c266">wait_job</reimplementedby>
<param>
<type><ref refid="structgc__job__desc" kindref="compound">gc_job_desc</ref> *</type>
<declname>jd</declname>
</param>
<briefdescription>
<para>Wait for job to complete. </para> </briefdescription>
<detaileddescription>
<para>A thread may only wait for jobs which it submitted.</para><para><simplesect kind="return"><para>true if sucessful, else false. </para></simplesect>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="210"/>
</memberdef>
<memberdef kind="function" id="classgc__job__manager_1a3f202d807a08d7756112388ce9fd03ff" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
<type>int</type>
<definition>virtual int gc_job_manager::wait_jobs</definition>
<argsstring>(unsigned int njobs, gc_job_desc *jd[], bool done[], gc_wait_mode mode)=0</argsstring>
<name>wait_jobs</name>
<reimplementedby refid="classgc__job__manager__impl_1abba55d25693227d82ce4afa74b6a1fcb">wait_jobs</reimplementedby>
<param>
<type>unsigned int</type>
<declname>njobs</declname>
</param>
<param>
<type><ref refid="structgc__job__desc" kindref="compound">gc_job_desc</ref> *</type>
<declname>jd</declname>
<array>[]</array>
</param>
<param>
<type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
<declname>done</declname>
<array>[]</array>
</param>
<param>
<type><ref refid="gc__job__manager_8h_1ab5ff7bcddb7471da0c9f1f0d7dbe038c" kindref="member">gc_wait_mode</ref></type>
<declname>mode</declname>
</param>
<briefdescription>
<para>wait for 1 or more jobs to complete. </para> </briefdescription>
<detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">njobs</parametername>
</parameternamelist>
<parameterdescription>
<para>is the length of arrays <computeroutput>jd</computeroutput> and <computeroutput>done</computeroutput>. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">jd</parametername>
</parameternamelist>
<parameterdescription>
<para>are the jobs that are to be waited for. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">done</parametername>
</parameternamelist>
<parameterdescription>
<para>indicates whether the corresponding job is complete. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">mode</parametername>
</parameternamelist>
<parameterdescription>
<para>indicates whether to wait for ALL or ANY of the jobs in <computeroutput>jd</computeroutput> to complete.</para></parameterdescription>
</parameteritem>
</parameterlist>
A thread may only wait for jobs which it submitted.</para><para><simplesect kind="return"><para>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. </para></simplesect>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="229"/>
</memberdef>
<memberdef kind="function" id="classgc__job__manager_1acd5c7de0370f3186ae467f8db24ca94d" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
<type>int</type>
<definition>virtual int gc_job_manager::ea_args_maxsize</definition>
<argsstring>()=0</argsstring>
<name>ea_args_maxsize</name>
<reimplementedby refid="classgc__job__manager__impl_1ad5076a7ebbef03a29f7dbfb15c2b7077">ea_args_maxsize</reimplementedby>
<briefdescription>
</briefdescription>
<detaileddescription>
<para>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. <simplesect kind="see"><para><ref refid="group__gcell_1ga1437283a479e08d5d674007709805657" kindref="member">gc_job_desc_t</ref>, <ref refid="gc__job__desc_8h_1aaf241ad9e3f4fabafcbecbbea760298a" kindref="member">gc_job_ea_args_t</ref> </para></simplesect>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="237"/>
</memberdef>
<memberdef kind="function" id="classgc__job__manager_1aebe49e58ce5ffc139b133bd5c1d1675b" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
<type><ref refid="gc__job__desc_8h_1a26e60e5aaade61f7c333ee636940a658" kindref="member">gc_proc_id_t</ref></type>
<definition>virtual gc_proc_id_t gc_job_manager::lookup_proc</definition>
<argsstring>(const std::string &proc_name)=0</argsstring>
<name>lookup_proc</name>
<reimplementedby refid="classgc__job__manager__impl_1ad997884dd828c691e5505f85d9760271">lookup_proc</reimplementedby>
<param>
<type>const std::string &</type>
<declname>proc_name</declname>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
<para>Return gc_proc_id_t associated with spu procedure <computeroutput>proc_name</computeroutput> if one exists, otherwise throws <ref refid="classgc__unknown__proc" kindref="compound">gc_unknown_proc</ref>. </para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="243"/>
</memberdef>
<memberdef kind="function" id="classgc__job__manager_1a62257a6f86bf862494054a1a57cb128c" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
<type><ref refid="classstd_1_1vector" kindref="compound">std::vector</ref>< std::string ></type>
<definition>virtual std::vector<std::string> gc_job_manager::proc_names</definition>
<argsstring>()=0</argsstring>
<name>proc_names</name>
<reimplementedby refid="classgc__job__manager__impl_1aa2933ca9cfc5623d9041576de73181f4">proc_names</reimplementedby>
<briefdescription>
</briefdescription>
<detaileddescription>
<para>Return a vector of all known spu procedure names. </para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="248"/>
</memberdef>
</sectiondef>
<sectiondef kind="public-static-func">
<memberdef kind="function" id="classgc__job__manager_1a4df28764e574674ae33ab149982fa0da" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
<definition>static void gc_job_manager::set_singleton</definition>
<argsstring>(gc_job_manager_sptr mgr)</argsstring>
<name>set_singleton</name>
<param>
<type><ref refid="classboost_1_1shared__ptr" kindref="compound">gc_job_manager_sptr</ref></type>
<declname>mgr</declname>
</param>
<briefdescription>
<para>Set the singleton <ref refid="classgc__job__manager" kindref="compound">gc_job_manager</ref> instance. </para> </briefdescription>
<detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>mgr</parametername>
</parameternamelist>
<parameterdescription>
<para>is the job manager instance.</para></parameterdescription>
</parameteritem>
</parameterlist>
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. </para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="265"/>
</memberdef>
<memberdef kind="function" id="classgc__job__manager_1a02b46ba7fd4fbd19fa18a3e2dd500a62" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type><ref refid="classboost_1_1shared__ptr" kindref="compound">gc_job_manager_sptr</ref></type>
<definition>static gc_job_manager_sptr gc_job_manager::singleton</definition>
<argsstring>()</argsstring>
<name>singleton</name>
<briefdescription>
<para>Retrieve the singleton <ref refid="classgc__job__manager" kindref="compound">gc_job_manager</ref> instance. </para> </briefdescription>
<detaileddescription>
<para>Returns the singleton <ref refid="classgc__job__manager" kindref="compound">gc_job_manager</ref> instance or raises boost::bad_weak_ptr if the singleton is empty. </para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="273"/>
</memberdef>
<memberdef kind="function" id="classgc__job__manager_1afdbb9fd2337021451ae1f646b0495bec" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type><ref refid="classboost_1_1shared__ptr" kindref="compound">gc_job_desc_sptr</ref></type>
<definition>static gc_job_desc_sptr gc_job_manager::alloc_job_desc</definition>
<argsstring>(gc_job_manager_sptr mgr)</argsstring>
<name>alloc_job_desc</name>
<param>
<type><ref refid="classboost_1_1shared__ptr" kindref="compound">gc_job_manager_sptr</ref></type>
<declname>mgr</declname>
</param>
<briefdescription>
<para>allocate a job descriptor and return a <ref refid="classboost_1_1shared__ptr" kindref="compound">boost::shared_ptr</ref> to it. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="283"/>
</memberdef>
</sectiondef>
<briefdescription>
<para>Abstract class that manages SPE jobs.</para><para>There is typically a single instance derived from this class. It is safe to call its methods from any thread. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inheritancegraph>
<node id="5145">
<label>gc_job_manager</label>
<link refid="classgc__job__manager"/>
</node>
<node id="5146">
<label>gc_job_manager_impl</label>
<link refid="classgc__job__manager__impl"/>
<childnode refid="5145" relation="public-inheritance">
</childnode>
</node>
</inheritancegraph>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="158" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" bodystart="157" bodyend="284"/>
<listofallmembers>
<member refid="classgc__job__manager_1a22f39fc07b55782205b914555b8cb10a" prot="public" virt="pure-virtual"><scope>gc_job_manager</scope><name>alloc_job_desc</name></member>
<member refid="classgc__job__manager_1afdbb9fd2337021451ae1f646b0495bec" prot="public" virt="non-virtual"><scope>gc_job_manager</scope><name>alloc_job_desc</name></member>
<member refid="classgc__job__manager_1acd5c7de0370f3186ae467f8db24ca94d" prot="public" virt="pure-virtual"><scope>gc_job_manager</scope><name>ea_args_maxsize</name></member>
<member refid="classgc__job__manager_1a0aeeb7c3b20089adcd521179a33e326d" prot="public" virt="pure-virtual"><scope>gc_job_manager</scope><name>free_job_desc</name></member>
<member refid="classgc__job__manager_1a55d6e5f2dd1035a1d0d915c3d890916f" prot="public" virt="non-virtual"><scope>gc_job_manager</scope><name>gc_job_manager</name></member>
<member refid="classgc__job__manager_1aebe49e58ce5ffc139b133bd5c1d1675b" prot="public" virt="pure-virtual"><scope>gc_job_manager</scope><name>lookup_proc</name></member>
<member refid="classgc__job__manager_1a50d8e2f20b58d1c6743d86277664cad2" prot="public" virt="pure-virtual"><scope>gc_job_manager</scope><name>nspes</name></member>
<member refid="classgc__job__manager_1a62257a6f86bf862494054a1a57cb128c" prot="public" virt="pure-virtual"><scope>gc_job_manager</scope><name>proc_names</name></member>
<member refid="classgc__job__manager_1a4df28764e574674ae33ab149982fa0da" prot="public" virt="non-virtual"><scope>gc_job_manager</scope><name>set_singleton</name></member>
<member refid="classgc__job__manager_1a12ba6187460071d427305809cae8a5ba" prot="public" virt="pure-virtual"><scope>gc_job_manager</scope><name>shutdown</name></member>
<member refid="classgc__job__manager_1a02b46ba7fd4fbd19fa18a3e2dd500a62" prot="public" virt="non-virtual"><scope>gc_job_manager</scope><name>singleton</name></member>
<member refid="classgc__job__manager_1a050c7cc1ed51f2ff5a6e41541c55cf29" prot="public" virt="pure-virtual"><scope>gc_job_manager</scope><name>submit_job</name></member>
<member refid="classgc__job__manager_1ad323d06be028cd5f4848cbd7451b2114" prot="public" virt="pure-virtual"><scope>gc_job_manager</scope><name>wait_job</name></member>
<member refid="classgc__job__manager_1a3f202d807a08d7756112388ce9fd03ff" prot="public" virt="pure-virtual"><scope>gc_job_manager</scope><name>wait_jobs</name></member>
<member refid="classgc__job__manager_1a40094f709ede2264ec1df985e996a411" prot="public" virt="virtual"><scope>gc_job_manager</scope><name>~gc_job_manager</name></member>
</listofallmembers>
</compounddef>
</doxygen>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
7484
