Sophie

Sophie

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

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="classusrp2_1_1pending__reply" kind="class" prot="public">
    <compoundname>usrp2::pending_reply</compoundname>
    <includes refid="control_8h" local="no">control.h</includes>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classusrp2_1_1pending__reply_1a6de37e65f53624a226b88a60d05e9d12" prot="private" static="no" mutable="no">
        <type>unsigned int</type>
        <definition>unsigned int usrp2::pending_reply::d_rid</definition>
        <argsstring></argsstring>
        <name>d_rid</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" line="120" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" bodystart="120" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classusrp2_1_1pending__reply_1ac3ae912d88842811f7d5889f43e7df2d" prot="private" static="no" mutable="no">
        <type><ref refid="classomni__mutex" kindref="compound">omni_mutex</ref></type>
        <definition>omni_mutex usrp2::pending_reply::d_mutex</definition>
        <argsstring></argsstring>
        <name>d_mutex</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" line="121" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" bodystart="121" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classusrp2_1_1pending__reply_1a869c7f08ed144a39019054bf785d593b" prot="private" static="no" mutable="no">
        <type><ref refid="classomni__condition" kindref="compound">omni_condition</ref></type>
        <definition>omni_condition usrp2::pending_reply::d_cond</definition>
        <argsstring></argsstring>
        <name>d_cond</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" line="122" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" bodystart="122" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classusrp2_1_1pending__reply_1a112356ba0aaf68d4878153abcc31ba2d" prot="private" static="no" mutable="no">
        <type>void *</type>
        <definition>void* usrp2::pending_reply::d_buffer</definition>
        <argsstring></argsstring>
        <name>d_buffer</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" line="123" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" bodystart="123" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classusrp2_1_1pending__reply_1a4cc237835df328eeb3596bfe41e66f43" prot="private" static="no" mutable="no">
        <type>size_t</type>
        <definition>size_t usrp2::pending_reply::d_len</definition>
        <argsstring></argsstring>
        <name>d_len</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" line="124" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" bodystart="124" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classusrp2_1_1pending__reply_1a8c3e31a0f94a87ef117904df195334f3" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>usrp2::pending_reply::pending_reply</definition>
        <argsstring>(unsigned int rid, void *buffer, size_t len)</argsstring>
        <name>pending_reply</name>
        <param>
          <type>unsigned int</type>
          <declname>rid</declname>
        </param>
        <param>
          <type>void *</type>
          <declname>buffer</declname>
        </param>
        <param>
          <type>size_t</type>
          <declname>len</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Construct a pending reply from the reply ID, response packet buffer, and buffer length. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" line="131"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1pending__reply_1abdb19d21bab42e409d8e96f76088d477" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>usrp2::pending_reply::~pending_reply</definition>
        <argsstring>()</argsstring>
        <name>~pending_reply</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Destructor. Signals creating thread. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" line="136"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1pending__reply_1a414a1e44d4dd36a6c3669afcfde754f6" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>int</type>
        <definition>int usrp2::pending_reply::wait</definition>
        <argsstring>(double secs)</argsstring>
        <name>wait</name>
        <param>
          <type>double</type>
          <declname>secs</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Block, waiting for reply packet. Returns: 1 = ok, reply packet in buffer 0 = timeout </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" line="143"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1pending__reply_1a7710c2bd1dbc8db9951c5d821b7f4f7b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void usrp2::pending_reply::signal</definition>
        <argsstring>()</argsstring>
        <name>signal</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Allows creating thread to resume after copying reply into buffer </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" line="148"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1pending__reply_1a8e2d214a13ec207cb47cfecb0ceff1b4" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>unsigned int</type>
        <definition>unsigned int usrp2::pending_reply::rid</definition>
        <argsstring>() const </argsstring>
        <name>rid</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Retrieve pending reply ID </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" line="153" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" bodystart="153" bodyend="153"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1pending__reply_1a859e3b9e286eab8aa27c846832616149" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>void *</type>
        <definition>void* usrp2::pending_reply::buffer</definition>
        <argsstring>() const </argsstring>
        <name>buffer</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Retrieve destination buffer address </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" line="158" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" bodystart="158" bodyend="158"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1pending__reply_1a477d193bace79353d2fe4c4afbe45d8b" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>size_t</type>
        <definition>size_t usrp2::pending_reply::len</definition>
        <argsstring>() const </argsstring>
        <name>len</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Retrieve destination buffer length </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" line="163" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" bodystart="163" bodyend="163"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
<para>Control mechanism to allow API calls to block waiting for reply packets </para>    </detaileddescription>
    <collaborationgraph>
      <node id="15741">
        <label>usrp2::pending_reply</label>
        <link refid="classusrp2_1_1pending__reply"/>
        <childnode refid="15742" relation="usage">
          <edgelabel>d_cond</edgelabel>
        </childnode>
        <childnode refid="15743" relation="usage">
          <edgelabel>d_mutex</edgelabel>
        </childnode>
      </node>
      <node id="15742">
        <label>omni_condition</label>
        <link refid="classomni__condition"/>
        <childnode refid="15743" relation="usage">
          <edgelabel>mutex</edgelabel>
        </childnode>
      </node>
      <node id="15743">
        <label>omni_mutex</label>
        <link refid="classomni__mutex"/>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" line="118" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/control.h" bodystart="117" bodyend="164"/>
    <listofallmembers>
      <member refid="classusrp2_1_1pending__reply_1a859e3b9e286eab8aa27c846832616149" prot="public" virt="non-virtual"><scope>usrp2::pending_reply</scope><name>buffer</name></member>
      <member refid="classusrp2_1_1pending__reply_1a112356ba0aaf68d4878153abcc31ba2d" prot="private" virt="non-virtual"><scope>usrp2::pending_reply</scope><name>d_buffer</name></member>
      <member refid="classusrp2_1_1pending__reply_1a869c7f08ed144a39019054bf785d593b" prot="private" virt="non-virtual"><scope>usrp2::pending_reply</scope><name>d_cond</name></member>
      <member refid="classusrp2_1_1pending__reply_1a4cc237835df328eeb3596bfe41e66f43" prot="private" virt="non-virtual"><scope>usrp2::pending_reply</scope><name>d_len</name></member>
      <member refid="classusrp2_1_1pending__reply_1ac3ae912d88842811f7d5889f43e7df2d" prot="private" virt="non-virtual"><scope>usrp2::pending_reply</scope><name>d_mutex</name></member>
      <member refid="classusrp2_1_1pending__reply_1a6de37e65f53624a226b88a60d05e9d12" prot="private" virt="non-virtual"><scope>usrp2::pending_reply</scope><name>d_rid</name></member>
      <member refid="classusrp2_1_1pending__reply_1a477d193bace79353d2fe4c4afbe45d8b" prot="public" virt="non-virtual"><scope>usrp2::pending_reply</scope><name>len</name></member>
      <member refid="classusrp2_1_1pending__reply_1a8c3e31a0f94a87ef117904df195334f3" prot="public" virt="non-virtual"><scope>usrp2::pending_reply</scope><name>pending_reply</name></member>
      <member refid="classusrp2_1_1pending__reply_1a8e2d214a13ec207cb47cfecb0ceff1b4" prot="public" virt="non-virtual"><scope>usrp2::pending_reply</scope><name>rid</name></member>
      <member refid="classusrp2_1_1pending__reply_1a7710c2bd1dbc8db9951c5d821b7f4f7b" prot="public" virt="non-virtual"><scope>usrp2::pending_reply</scope><name>signal</name></member>
      <member refid="classusrp2_1_1pending__reply_1a414a1e44d4dd36a6c3669afcfde754f6" prot="public" virt="non-virtual"><scope>usrp2::pending_reply</scope><name>wait</name></member>
      <member refid="classusrp2_1_1pending__reply_1abdb19d21bab42e409d8e96f76088d477" prot="public" virt="non-virtual"><scope>usrp2::pending_reply</scope><name>~pending_reply</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>