Sophie

Sophie

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

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_1ethernet" kind="class" prot="public">
    <compoundname>usrp2::ethernet</compoundname>
    <includes refid="ethernet_8h" local="no">ethernet.h</includes>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classusrp2_1_1ethernet_1a4eee1821c3e3a3a33db94a80f88222a5" prot="private" static="no" mutable="no">
        <type>int</type>
        <definition>int usrp2::ethernet::d_fd</definition>
        <argsstring></argsstring>
        <name>d_fd</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" line="37" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" bodystart="37" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classusrp2_1_1ethernet_1a80ddbd846b53c06cd791017bef0c3ee8" prot="private" static="no" mutable="no">
        <type>uint8_t</type>
        <definition>uint8_t usrp2::ethernet::d_mac[6]</definition>
        <argsstring>[6]</argsstring>
        <name>d_mac</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" line="38" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" bodystart="38" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-static-attrib">
      <memberdef kind="variable" id="classusrp2_1_1ethernet_1a9162657db5b12f93c260e144d56f2f8b" prot="public" static="yes" mutable="no">
        <type>const int</type>
        <definition>const int usrp2::ethernet::MAX_PKTLEN</definition>
        <argsstring></argsstring>
        <name>MAX_PKTLEN</name>
        <initializer> 1512</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" line="44" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" bodystart="44" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classusrp2_1_1ethernet_1a7eec2459c27e54d9fc62f9f0bb983a64" prot="public" static="yes" mutable="no">
        <type>const int</type>
        <definition>const int usrp2::ethernet::MIN_PKTLEN</definition>
        <argsstring></argsstring>
        <name>MIN_PKTLEN</name>
        <initializer> 64</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" line="45" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" bodystart="45" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classusrp2_1_1ethernet_1a830ede01419d423ed2a1504e39f98d26" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>usrp2::ethernet::ethernet</definition>
        <argsstring>()</argsstring>
        <name>ethernet</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" line="41"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1ethernet_1ac35784ad0a4a15a36d879656d7f28a43" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>usrp2::ethernet::~ethernet</definition>
        <argsstring>()</argsstring>
        <name>~ethernet</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" line="42"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1ethernet_1abbeb64f61c8aa796465976e6b3bfe10f" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>bool usrp2::ethernet::open</definition>
        <argsstring>(std::string ifname, int protocol)</argsstring>
        <name>open</name>
        <param>
          <type>std::string</type>
          <declname>ifname</declname>
        </param>
        <param>
          <type>int</type>
          <declname>protocol</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>ifname</parametername>
</parameternamelist>
<parameterdescription>
<para>ethernet interface name, e.g., &quot;eth0&quot; </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>protocol</parametername>
</parameternamelist>
<parameterdescription>
<para>is the ethertype protocol number in network order. Use 0 to receive all protocols. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" line="52"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1ethernet_1a647c874f69bcf12681c90a1149df109c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>bool usrp2::ethernet::close</definition>
        <argsstring>()</argsstring>
        <name>close</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" line="54"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1ethernet_1a5efc1935f87339afeee213b19aea46c7" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>bool usrp2::ethernet::attach_pktfilter</definition>
        <argsstring>(pktfilter *pf)</argsstring>
        <name>attach_pktfilter</name>
        <param>
          <type><ref refid="classusrp2_1_1pktfilter" kindref="compound">pktfilter</ref> *</type>
          <declname>pf</declname>
        </param>
        <briefdescription>
<para>attach packet filter to socket to restrict which packets read sees. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>pf</parametername>
</parameternamelist>
<parameterdescription>
<para>the packet filter </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" line="60"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1ethernet_1a34eb36ab2061627465ab3784a58c02e4" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>const uint8_t *</type>
        <definition>const uint8_t* usrp2::ethernet::mac</definition>
        <argsstring>() const </argsstring>
        <name>mac</name>
        <briefdescription>
<para>return 6 byte string containing our MAC address </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" line="65" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" bodystart="65" bodyend="65"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1ethernet_1abf9839099d07ee2e27d55e3ffc92ec99" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>int</type>
        <definition>int usrp2::ethernet::fd</definition>
        <argsstring>() const </argsstring>
        <name>fd</name>
        <briefdescription>
<para>Return file descriptor associated with socket. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" line="70" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" bodystart="70" bodyend="70"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1ethernet_1a755e8345eb87bb07397b727bdee161f3" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>int</type>
        <definition>int usrp2::ethernet::read_packet</definition>
        <argsstring>(void *buf, int buflen)</argsstring>
        <name>read_packet</name>
        <param>
          <type>void *</type>
          <declname>buf</declname>
        </param>
        <param>
          <type>int</type>
          <declname>buflen</declname>
        </param>
        <briefdescription>
<para>Read packet from interface. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>buf</parametername>
</parameternamelist>
<parameterdescription>
<para>where to put the packet </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>buflen</parametername>
</parameternamelist>
<parameterdescription>
<para>maximum length of packet in bytes (should be &gt;= 1528)</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>number of bytes read or -1 if trouble.</para></simplesect>
Returned packet includes 14-byte ethhdr </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" line="82"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1ethernet_1abb1065dad974e1d72e596129fc3b4f54" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>int</type>
        <definition>int usrp2::ethernet::read_packet_dont_block</definition>
        <argsstring>(void *buf, int buflen)</argsstring>
        <name>read_packet_dont_block</name>
        <param>
          <type>void *</type>
          <declname>buf</declname>
        </param>
        <param>
          <type>int</type>
          <declname>buflen</declname>
        </param>
        <briefdescription>
<para>Read packet from interface, but don&apos;t block waiting. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>buf</parametername>
</parameternamelist>
<parameterdescription>
<para>where to put the packet </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>buflen</parametername>
</parameternamelist>
<parameterdescription>
<para>maximum length of packet in bytes (should be &gt;= 1528)</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>number of bytes read, -1 if trouble or 0 if nothing available.</para></simplesect>
Returned packet includes 14-byte ethhdr </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" line="94"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1ethernet_1a9deb0e174bd0a273070c46f1bddaceeb" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>int</type>
        <definition>int usrp2::ethernet::write_packet</definition>
        <argsstring>(const void *buf, int buflen)</argsstring>
        <name>write_packet</name>
        <param>
          <type>const void *</type>
          <declname>buf</declname>
        </param>
        <param>
          <type>int</type>
          <declname>buflen</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" line="106"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1ethernet_1acd43b9c92c76c4e466b1d33945a6396d" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>int</type>
        <definition>int usrp2::ethernet::write_packetv</definition>
        <argsstring>(const eth_iovec *iov, size_t iovlen)</argsstring>
        <name>write_packetv</name>
        <param>
          <type>const eth_iovec *</type>
          <declname>iov</declname>
        </param>
        <param>
          <type>size_t</type>
          <declname>iovlen</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" line="118"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Read and write ethernet frames. </para>    </briefdescription>
    <detaileddescription>
<para>This provides a low level interface to hardware that communicates via raw (non-IP) ethernet frames. </para>    </detaileddescription>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" line="36" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/ethernet.h" bodystart="36" bodyend="120"/>
    <listofallmembers>
      <member refid="classusrp2_1_1ethernet_1a5efc1935f87339afeee213b19aea46c7" prot="public" virt="non-virtual"><scope>usrp2::ethernet</scope><name>attach_pktfilter</name></member>
      <member refid="classusrp2_1_1ethernet_1a647c874f69bcf12681c90a1149df109c" prot="public" virt="non-virtual"><scope>usrp2::ethernet</scope><name>close</name></member>
      <member refid="classusrp2_1_1ethernet_1a4eee1821c3e3a3a33db94a80f88222a5" prot="private" virt="non-virtual"><scope>usrp2::ethernet</scope><name>d_fd</name></member>
      <member refid="classusrp2_1_1ethernet_1a80ddbd846b53c06cd791017bef0c3ee8" prot="private" virt="non-virtual"><scope>usrp2::ethernet</scope><name>d_mac</name></member>
      <member refid="classusrp2_1_1ethernet_1a830ede01419d423ed2a1504e39f98d26" prot="public" virt="non-virtual"><scope>usrp2::ethernet</scope><name>ethernet</name></member>
      <member refid="classusrp2_1_1ethernet_1abf9839099d07ee2e27d55e3ffc92ec99" prot="public" virt="non-virtual"><scope>usrp2::ethernet</scope><name>fd</name></member>
      <member refid="classusrp2_1_1ethernet_1a34eb36ab2061627465ab3784a58c02e4" prot="public" virt="non-virtual"><scope>usrp2::ethernet</scope><name>mac</name></member>
      <member refid="classusrp2_1_1ethernet_1a9162657db5b12f93c260e144d56f2f8b" prot="public" virt="non-virtual"><scope>usrp2::ethernet</scope><name>MAX_PKTLEN</name></member>
      <member refid="classusrp2_1_1ethernet_1a7eec2459c27e54d9fc62f9f0bb983a64" prot="public" virt="non-virtual"><scope>usrp2::ethernet</scope><name>MIN_PKTLEN</name></member>
      <member refid="classusrp2_1_1ethernet_1abbeb64f61c8aa796465976e6b3bfe10f" prot="public" virt="non-virtual"><scope>usrp2::ethernet</scope><name>open</name></member>
      <member refid="classusrp2_1_1ethernet_1a755e8345eb87bb07397b727bdee161f3" prot="public" virt="non-virtual"><scope>usrp2::ethernet</scope><name>read_packet</name></member>
      <member refid="classusrp2_1_1ethernet_1abb1065dad974e1d72e596129fc3b4f54" prot="public" virt="non-virtual"><scope>usrp2::ethernet</scope><name>read_packet_dont_block</name></member>
      <member refid="classusrp2_1_1ethernet_1a9deb0e174bd0a273070c46f1bddaceeb" prot="public" virt="non-virtual"><scope>usrp2::ethernet</scope><name>write_packet</name></member>
      <member refid="classusrp2_1_1ethernet_1acd43b9c92c76c4e466b1d33945a6396d" prot="public" virt="non-virtual"><scope>usrp2::ethernet</scope><name>write_packetv</name></member>
      <member refid="classusrp2_1_1ethernet_1ac35784ad0a4a15a36d879656d7f28a43" prot="public" virt="non-virtual"><scope>usrp2::ethernet</scope><name>~ethernet</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>