<!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: usrp2::ethernet 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('classusrp2_1_1ethernet.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> </div>
<div class="headertitle">
<h1>usrp2::ethernet Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="usrp2::ethernet" -->
<p>Read and write ethernet frames.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="ethernet_8h_source.html">ethernet.h</a>></code></p>
<p><a href="classusrp2_1_1ethernet-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="classusrp2_1_1ethernet.html#a830ede01419d423ed2a1504e39f98d26">ethernet</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1ethernet.html#ac35784ad0a4a15a36d879656d7f28a43">~ethernet</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1ethernet.html#abbeb64f61c8aa796465976e6b3bfe10f">open</a> (std::string ifname, int protocol)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1ethernet.html#a647c874f69bcf12681c90a1149df109c">close</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1ethernet.html#a5efc1935f87339afeee213b19aea46c7">attach_pktfilter</a> (<a class="el" href="classusrp2_1_1pktfilter.html">pktfilter</a> *pf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">attach packet filter to socket to restrict which packets read sees. <a href="#a5efc1935f87339afeee213b19aea46c7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1ethernet.html#a34eb36ab2061627465ab3784a58c02e4">mac</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return 6 byte string containing our MAC address <a href="#a34eb36ab2061627465ab3784a58c02e4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1ethernet.html#abf9839099d07ee2e27d55e3ffc92ec99">fd</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return file descriptor associated with socket. <a href="#abf9839099d07ee2e27d55e3ffc92ec99"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1ethernet.html#a755e8345eb87bb07397b727bdee161f3">read_packet</a> (void *buf, int buflen)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read packet from interface. <a href="#a755e8345eb87bb07397b727bdee161f3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1ethernet.html#abb1065dad974e1d72e596129fc3b4f54">read_packet_dont_block</a> (void *buf, int buflen)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read packet from interface, but don't block waiting. <a href="#abb1065dad974e1d72e596129fc3b4f54"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1ethernet.html#a9deb0e174bd0a273070c46f1bddaceeb">write_packet</a> (const void *buf, int buflen)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1ethernet.html#acd43b9c92c76c4e466b1d33945a6396d">write_packetv</a> (const eth_iovec *iov, size_t iovlen)</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1ethernet.html#a9162657db5b12f93c260e144d56f2f8b">MAX_PKTLEN</a> = 1512</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1ethernet.html#a7eec2459c27e54d9fc62f9f0bb983a64">MIN_PKTLEN</a> = 64</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Read and write ethernet frames. </p>
<p>This provides a low level interface to hardware that communicates via raw (non-IP) ethernet frames. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a830ede01419d423ed2a1504e39f98d26"></a><!-- doxytag: member="usrp2::ethernet::ethernet" ref="a830ede01419d423ed2a1504e39f98d26" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">usrp2::ethernet::ethernet </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac35784ad0a4a15a36d879656d7f28a43"></a><!-- doxytag: member="usrp2::ethernet::~ethernet" ref="ac35784ad0a4a15a36d879656d7f28a43" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">usrp2::ethernet::~ethernet </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5efc1935f87339afeee213b19aea46c7"></a><!-- doxytag: member="usrp2::ethernet::attach_pktfilter" ref="a5efc1935f87339afeee213b19aea46c7" args="(pktfilter *pf)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> usrp2::ethernet::attach_pktfilter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classusrp2_1_1pktfilter.html">pktfilter</a> * </td>
<td class="paramname"><em>pf</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>attach packet filter to socket to restrict which packets read sees. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pf</td><td>the packet filter </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a647c874f69bcf12681c90a1149df109c"></a><!-- doxytag: member="usrp2::ethernet::close" ref="a647c874f69bcf12681c90a1149df109c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> usrp2::ethernet::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="abf9839099d07ee2e27d55e3ffc92ec99"></a><!-- doxytag: member="usrp2::ethernet::fd" ref="abf9839099d07ee2e27d55e3ffc92ec99" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int usrp2::ethernet::fd </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return file descriptor associated with socket. </p>
</div>
</div>
<a class="anchor" id="a34eb36ab2061627465ab3784a58c02e4"></a><!-- doxytag: member="usrp2::ethernet::mac" ref="a34eb36ab2061627465ab3784a58c02e4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const uint8_t* usrp2::ethernet::mac </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return 6 byte string containing our MAC address </p>
</div>
</div>
<a class="anchor" id="abbeb64f61c8aa796465976e6b3bfe10f"></a><!-- doxytag: member="usrp2::ethernet::open" ref="abbeb64f61c8aa796465976e6b3bfe10f" args="(std::string ifname, int protocol)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> usrp2::ethernet::open </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>ifname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>protocol</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ifname</td><td>ethernet interface name, e.g., "eth0" </td></tr>
<tr><td class="paramname">protocol</td><td>is the ethertype protocol number in network order. Use 0 to receive all protocols. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a755e8345eb87bb07397b727bdee161f3"></a><!-- doxytag: member="usrp2::ethernet::read_packet" ref="a755e8345eb87bb07397b727bdee161f3" args="(void *buf, int buflen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int usrp2::ethernet::read_packet </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>buflen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read packet from interface. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>where to put the packet </td></tr>
<tr><td class="paramname">buflen</td><td>maximum length of packet in bytes (should be >= 1528)</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes read or -1 if trouble.</dd></dl>
<p>Returned packet includes 14-byte ethhdr </p>
</div>
</div>
<a class="anchor" id="abb1065dad974e1d72e596129fc3b4f54"></a><!-- doxytag: member="usrp2::ethernet::read_packet_dont_block" ref="abb1065dad974e1d72e596129fc3b4f54" args="(void *buf, int buflen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int usrp2::ethernet::read_packet_dont_block </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>buflen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read packet from interface, but don't block waiting. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>where to put the packet </td></tr>
<tr><td class="paramname">buflen</td><td>maximum length of packet in bytes (should be >= 1528)</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes read, -1 if trouble or 0 if nothing available.</dd></dl>
<p>Returned packet includes 14-byte ethhdr </p>
</div>
</div>
<a class="anchor" id="a9deb0e174bd0a273070c46f1bddaceeb"></a><!-- doxytag: member="usrp2::ethernet::write_packet" ref="a9deb0e174bd0a273070c46f1bddaceeb" args="(const void *buf, int buflen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int usrp2::ethernet::write_packet </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>buflen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="acd43b9c92c76c4e466b1d33945a6396d"></a><!-- doxytag: member="usrp2::ethernet::write_packetv" ref="acd43b9c92c76c4e466b1d33945a6396d" args="(const eth_iovec *iov, size_t iovlen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int usrp2::ethernet::write_packetv </td>
<td>(</td>
<td class="paramtype">const eth_iovec * </td>
<td class="paramname"><em>iov</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>iovlen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a9162657db5b12f93c260e144d56f2f8b"></a><!-- doxytag: member="usrp2::ethernet::MAX_PKTLEN" ref="a9162657db5b12f93c260e144d56f2f8b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="classusrp2_1_1ethernet.html#a9162657db5b12f93c260e144d56f2f8b">usrp2::ethernet::MAX_PKTLEN</a> = 1512<code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a7eec2459c27e54d9fc62f9f0bb983a64"></a><!-- doxytag: member="usrp2::ethernet::MIN_PKTLEN" ref="a7eec2459c27e54d9fc62f9f0bb983a64" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="classusrp2_1_1ethernet.html#a7eec2459c27e54d9fc62f9f0bb983a64">usrp2::ethernet::MIN_PKTLEN</a> = 64<code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ethernet_8h_source.html">ethernet.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>usrp2</b> </li>
<li class="navelem"><a class="el" href="classusrp2_1_1ethernet.html">ethernet</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
>
2918
