Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 7698

gnuradio-doc-3.2.2-9.fc14.x86_64.rpm

<?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="classgr__msg__queue" kind="class" prot="public">
    <compoundname>gr_msg_queue</compoundname>
    <basecompoundref refid="classgr__msg__handler" prot="public" virt="non-virtual">gr_msg_handler</basecompoundref>
    <includes refid="gr__msg__queue_8h" local="no">gr_msg_queue.h</includes>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classgr__msg__queue_1ac9a082dc18c188bf44c735c501d5fa18" prot="private" static="no" mutable="no">
        <type><ref refid="classomni__mutex" kindref="compound">omni_mutex</ref></type>
        <definition>omni_mutex gr_msg_queue::d_mutex</definition>
        <argsstring></argsstring>
        <name>d_mutex</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" line="38" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" bodystart="38" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__msg__queue_1a9402c4be0ab94f3c21e656a4ac06d81f" prot="private" static="no" mutable="no">
        <type><ref refid="classomni__condition" kindref="compound">omni_condition</ref></type>
        <definition>omni_condition gr_msg_queue::d_not_empty</definition>
        <argsstring></argsstring>
        <name>d_not_empty</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" line="39" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" bodystart="39" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__msg__queue_1a523940ef13e36318ad966631aa2783e7" prot="private" static="no" mutable="no">
        <type><ref refid="classomni__condition" kindref="compound">omni_condition</ref></type>
        <definition>omni_condition gr_msg_queue::d_not_full</definition>
        <argsstring></argsstring>
        <name>d_not_full</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" line="40" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" bodystart="40" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__msg__queue_1a50ace0f96f459d0f626140dcb00e9144" prot="private" static="no" mutable="no">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_message_sptr</ref></type>
        <definition>gr_message_sptr gr_msg_queue::d_head</definition>
        <argsstring></argsstring>
        <name>d_head</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" line="41" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" bodystart="41" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__msg__queue_1af08299e8d2677c2fd0f7286624ea0d40" prot="private" static="no" mutable="no">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_message_sptr</ref></type>
        <definition>gr_message_sptr gr_msg_queue::d_tail</definition>
        <argsstring></argsstring>
        <name>d_tail</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" line="42" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" bodystart="42" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__msg__queue_1a61a2d941739311a326d5b1a896ea093f" prot="private" static="no" mutable="no">
        <type>unsigned int</type>
        <definition>unsigned int gr_msg_queue::d_count</definition>
        <argsstring></argsstring>
        <name>d_count</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" line="43" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" bodystart="43" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__msg__queue_1a3bb33981b14ba41df085214953b08b3a" prot="private" static="no" mutable="no">
        <type>unsigned int</type>
        <definition>unsigned int gr_msg_queue::d_limit</definition>
        <argsstring></argsstring>
        <name>d_limit</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" line="44" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" bodystart="44" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classgr__msg__queue_1afdb2b45e3fa48b751af1c0efa5b64a6e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>gr_msg_queue::gr_msg_queue</definition>
        <argsstring>(unsigned int limit)</argsstring>
        <name>gr_msg_queue</name>
        <param>
          <type>unsigned int</type>
          <declname>limit</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" line="47"/>
      </memberdef>
      <memberdef kind="function" id="classgr__msg__queue_1aa69ef4aea1bdc792d15e6c76bb53a58b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>gr_msg_queue::~gr_msg_queue</definition>
        <argsstring>()</argsstring>
        <name>~gr_msg_queue</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" line="48"/>
      </memberdef>
      <memberdef kind="function" id="classgr__msg__queue_1a2e2a98602dc08f2999916db33f0dcfaf" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
        <type>void</type>
        <definition>void gr_msg_queue::handle</definition>
        <argsstring>(gr_message_sptr msg)</argsstring>
        <name>handle</name>
        <reimplements refid="classgr__msg__handler_1aa0c903a19349849a27b037428e377d0b">handle</reimplements>
        <param>
          <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_message_sptr</ref></type>
          <declname>msg</declname>
        </param>
        <briefdescription>
<para>Generic msg_handler method: insert the message. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" line="51" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" bodystart="51" bodyend="51"/>
        <references refid="classgr__msg__queue_1ae62e52ad8e7db84d20775b26dd0d7776">insert_tail</references>
      </memberdef>
      <memberdef kind="function" id="classgr__msg__queue_1ae62e52ad8e7db84d20775b26dd0d7776" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void gr_msg_queue::insert_tail</definition>
        <argsstring>(gr_message_sptr msg)</argsstring>
        <name>insert_tail</name>
        <param>
          <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_message_sptr</ref></type>
          <declname>msg</declname>
        </param>
        <briefdescription>
<para>Insert message at tail of queue. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>msg</parametername>
</parameternamelist>
<parameterdescription>
<para>message</para></parameterdescription>
</parameteritem>
</parameterlist>
Block if queue if full. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" line="59"/>
        <referencedby refid="classgr__msg__queue_1a2e2a98602dc08f2999916db33f0dcfaf" compoundref="gr__msg__queue_8h" startline="51" endline="51">handle</referencedby>
      </memberdef>
      <memberdef kind="function" id="classgr__msg__queue_1a37f3be5d0dc5c6470c552b7cc1c2772d" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_message_sptr</ref></type>
        <definition>gr_message_sptr gr_msg_queue::delete_head</definition>
        <argsstring>()</argsstring>
        <name>delete_head</name>
        <briefdescription>
<para>Delete message from head of queue and return it. Block if no message is available. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" line="65"/>
      </memberdef>
      <memberdef kind="function" id="classgr__msg__queue_1a4350864fc60a2e49d9027c0826d20a07" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_message_sptr</ref></type>
        <definition>gr_message_sptr gr_msg_queue::delete_head_nowait</definition>
        <argsstring>()</argsstring>
        <name>delete_head_nowait</name>
        <briefdescription>
<para>If there&apos;s a message in the q, delete it and return it. If no message is available, return 0. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" line="71"/>
      </memberdef>
      <memberdef kind="function" id="classgr__msg__queue_1a06f0bf5384d9b877ac53684dd19e05e3" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void gr_msg_queue::flush</definition>
        <argsstring>()</argsstring>
        <name>flush</name>
        <briefdescription>
<para>Delete all messages from the queue. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" line="74"/>
      </memberdef>
      <memberdef kind="function" id="classgr__msg__queue_1a0e4773212eb96752d2ada250ed3e2cf9" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>bool gr_msg_queue::empty_p</definition>
        <argsstring>() const </argsstring>
        <name>empty_p</name>
        <briefdescription>
<para>is the queue empty? </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" line="77" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" bodystart="77" bodyend="77"/>
      </memberdef>
      <memberdef kind="function" id="classgr__msg__queue_1a993d45fb88afcc36cae5827b7c6c5b91" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>bool gr_msg_queue::full_p</definition>
        <argsstring>() const </argsstring>
        <name>full_p</name>
        <briefdescription>
<para>is the queue full? </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" line="80" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" bodystart="80" bodyend="80"/>
      </memberdef>
      <memberdef kind="function" id="classgr__msg__queue_1af0e4495b5ef776624ac170bbbb7a6bf7" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>unsigned int</type>
        <definition>unsigned int gr_msg_queue::count</definition>
        <argsstring>() const </argsstring>
        <name>count</name>
        <briefdescription>
<para>return number of messages in queue </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" line="83" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" bodystart="83" bodyend="83"/>
      </memberdef>
      <memberdef kind="function" id="classgr__msg__queue_1aa614d591169f4fca48fa28d8caa4da6d" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>unsigned int</type>
        <definition>unsigned int gr_msg_queue::limit</definition>
        <argsstring>() const </argsstring>
        <name>limit</name>
        <briefdescription>
<para>return limit on number of message in queue. 0 -&gt; unbounded </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" line="86" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" bodystart="86" bodyend="86"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>thread-safe message queue </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="10475">
        <label>gr_msg_handler</label>
        <link refid="classgr__msg__handler"/>
      </node>
      <node id="10474">
        <label>gr_msg_queue</label>
        <link refid="classgr__msg__queue"/>
        <childnode refid="10475" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="10478">
        <label>boost::shared_ptr&lt; gr_message &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="10479" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="10479">
        <label>gr_message</label>
        <link refid="classgr__message"/>
        <childnode refid="10478" relation="usage">
          <edgelabel>d_next</edgelabel>
        </childnode>
      </node>
      <node id="10477">
        <label>gr_msg_handler</label>
        <link refid="classgr__msg__handler"/>
      </node>
      <node id="10480">
        <label>omni_condition</label>
        <link refid="classomni__condition"/>
        <childnode refid="10481" relation="usage">
          <edgelabel>mutex</edgelabel>
        </childnode>
      </node>
      <node id="10476">
        <label>gr_msg_queue</label>
        <link refid="classgr__msg__queue"/>
        <childnode refid="10477" relation="public-inheritance">
        </childnode>
        <childnode refid="10478" relation="usage">
          <edgelabel>d_head</edgelabel>
          <edgelabel>d_tail</edgelabel>
        </childnode>
        <childnode refid="10480" relation="usage">
          <edgelabel>d_not_empty</edgelabel>
          <edgelabel>d_not_full</edgelabel>
        </childnode>
        <childnode refid="10481" relation="usage">
          <edgelabel>d_mutex</edgelabel>
        </childnode>
      </node>
      <node id="10481">
        <label>omni_mutex</label>
        <link refid="classomni__mutex"/>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" line="37" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_msg_queue.h" bodystart="37" bodyend="88"/>
    <listofallmembers>
      <member refid="classgr__msg__queue_1af0e4495b5ef776624ac170bbbb7a6bf7" prot="public" virt="non-virtual"><scope>gr_msg_queue</scope><name>count</name></member>
      <member refid="classgr__msg__queue_1a61a2d941739311a326d5b1a896ea093f" prot="private" virt="non-virtual"><scope>gr_msg_queue</scope><name>d_count</name></member>
      <member refid="classgr__msg__queue_1a50ace0f96f459d0f626140dcb00e9144" prot="private" virt="non-virtual"><scope>gr_msg_queue</scope><name>d_head</name></member>
      <member refid="classgr__msg__queue_1a3bb33981b14ba41df085214953b08b3a" prot="private" virt="non-virtual"><scope>gr_msg_queue</scope><name>d_limit</name></member>
      <member refid="classgr__msg__queue_1ac9a082dc18c188bf44c735c501d5fa18" prot="private" virt="non-virtual"><scope>gr_msg_queue</scope><name>d_mutex</name></member>
      <member refid="classgr__msg__queue_1a9402c4be0ab94f3c21e656a4ac06d81f" prot="private" virt="non-virtual"><scope>gr_msg_queue</scope><name>d_not_empty</name></member>
      <member refid="classgr__msg__queue_1a523940ef13e36318ad966631aa2783e7" prot="private" virt="non-virtual"><scope>gr_msg_queue</scope><name>d_not_full</name></member>
      <member refid="classgr__msg__queue_1af08299e8d2677c2fd0f7286624ea0d40" prot="private" virt="non-virtual"><scope>gr_msg_queue</scope><name>d_tail</name></member>
      <member refid="classgr__msg__queue_1a37f3be5d0dc5c6470c552b7cc1c2772d" prot="public" virt="non-virtual"><scope>gr_msg_queue</scope><name>delete_head</name></member>
      <member refid="classgr__msg__queue_1a4350864fc60a2e49d9027c0826d20a07" prot="public" virt="non-virtual"><scope>gr_msg_queue</scope><name>delete_head_nowait</name></member>
      <member refid="classgr__msg__queue_1a0e4773212eb96752d2ada250ed3e2cf9" prot="public" virt="non-virtual"><scope>gr_msg_queue</scope><name>empty_p</name></member>
      <member refid="classgr__msg__queue_1a06f0bf5384d9b877ac53684dd19e05e3" prot="public" virt="non-virtual"><scope>gr_msg_queue</scope><name>flush</name></member>
      <member refid="classgr__msg__queue_1a993d45fb88afcc36cae5827b7c6c5b91" prot="public" virt="non-virtual"><scope>gr_msg_queue</scope><name>full_p</name></member>
      <member refid="classgr__msg__queue_1afdb2b45e3fa48b751af1c0efa5b64a6e" prot="public" virt="non-virtual"><scope>gr_msg_queue</scope><name>gr_msg_queue</name></member>
      <member refid="classgr__msg__queue_1a2e2a98602dc08f2999916db33f0dcfaf" prot="public" virt="virtual"><scope>gr_msg_queue</scope><name>handle</name></member>
      <member refid="classgr__msg__queue_1ae62e52ad8e7db84d20775b26dd0d7776" prot="public" virt="non-virtual"><scope>gr_msg_queue</scope><name>insert_tail</name></member>
      <member refid="classgr__msg__queue_1aa614d591169f4fca48fa28d8caa4da6d" prot="public" virt="non-virtual"><scope>gr_msg_queue</scope><name>limit</name></member>
      <member refid="classgr__msg__handler_1a226f43d90761d60f23912aae41ffa217" prot="public" virt="virtual"><scope>gr_msg_queue</scope><name>~gr_msg_handler</name></member>
      <member refid="classgr__msg__queue_1aa69ef4aea1bdc792d15e6c76bb53a58b" prot="public" virt="non-virtual"><scope>gr_msg_queue</scope><name>~gr_msg_queue</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>