<!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: ethernet.h Source File</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('ethernet_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>ethernet.h</h1> </div>
</div>
<div class="contents">
<a href="ethernet_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2005,2007,2008 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * This program is free software: you can redistribute it and/or modify</span>
<a name="l00006"></a>00006 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00007"></a>00007 <span class="comment"> * the Free Software Foundation, either version 3 of the License, or</span>
<a name="l00008"></a>00008 <span class="comment"> * (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00013"></a>00013 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"> *</span>
<a name="l00015"></a>00015 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00016"></a>00016 <span class="comment"> * along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
<a name="l00017"></a>00017 <span class="comment"> */</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef INCLUDED_USRP2_ETHERNET_H</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_USRP2_ETHERNET_H</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <string></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include <vector></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include <<a class="code" href="eth__common_8h.html">eth_common.h</a>></span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="keyword">namespace </span>usrp2 {
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="keyword">class </span>pktfilter;
<a name="l00029"></a>00029 <span class="comment"></span>
<a name="l00030"></a>00030 <span class="comment"> /*!</span>
<a name="l00031"></a>00031 <span class="comment"> * \brief Read and write ethernet frames.</span>
<a name="l00032"></a>00032 <span class="comment"> *</span>
<a name="l00033"></a>00033 <span class="comment"> * This provides a low level interface to hardware that communicates</span>
<a name="l00034"></a>00034 <span class="comment"> * via raw (non-IP) ethernet frames.</span>
<a name="l00035"></a>00035 <span class="comment"> */</span>
<a name="l00036"></a><a class="code" href="classusrp2_1_1ethernet.html">00036</a> <span class="keyword">class </span><a class="code" href="classusrp2_1_1ethernet.html" title="Read and write ethernet frames.">ethernet</a> {
<a name="l00037"></a>00037 <span class="keywordtype">int</span> d_fd;
<a name="l00038"></a>00038 uint8_t d_mac[6];
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="keyword">public</span>:
<a name="l00041"></a>00041 <a class="code" href="classusrp2_1_1ethernet.html#a830ede01419d423ed2a1504e39f98d26">ethernet</a> ();
<a name="l00042"></a>00042 <a class="code" href="classusrp2_1_1ethernet.html#ac35784ad0a4a15a36d879656d7f28a43">~ethernet</a> ();
<a name="l00043"></a>00043
<a name="l00044"></a><a class="code" href="classusrp2_1_1ethernet.html#a9162657db5b12f93c260e144d56f2f8b">00044</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classusrp2_1_1ethernet.html#a9162657db5b12f93c260e144d56f2f8b">MAX_PKTLEN</a> = 1512;
<a name="l00045"></a><a class="code" href="classusrp2_1_1ethernet.html#a7eec2459c27e54d9fc62f9f0bb983a64">00045</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classusrp2_1_1ethernet.html#a7eec2459c27e54d9fc62f9f0bb983a64">MIN_PKTLEN</a> = 64;
<a name="l00046"></a>00046 <span class="comment"></span>
<a name="l00047"></a>00047 <span class="comment"> /*!</span>
<a name="l00048"></a>00048 <span class="comment"> * \param ifname ethernet interface name, e.g., "eth0"</span>
<a name="l00049"></a>00049 <span class="comment"> * \param protocol is the ethertype protocol number in network order.</span>
<a name="l00050"></a>00050 <span class="comment"> * Use 0 to receive all protocols.</span>
<a name="l00051"></a>00051 <span class="comment"> */</span>
<a name="l00052"></a>00052 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1ethernet.html#abbeb64f61c8aa796465976e6b3bfe10f">open</a> (std::string ifname, <span class="keywordtype">int</span> protocol);
<a name="l00053"></a>00053
<a name="l00054"></a>00054 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1ethernet.html#a647c874f69bcf12681c90a1149df109c">close</a> ();
<a name="l00055"></a>00055 <span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment"> /*!</span>
<a name="l00057"></a>00057 <span class="comment"> * \brief attach packet filter to socket to restrict which packets read sees.</span>
<a name="l00058"></a>00058 <span class="comment"> * \param pf the packet filter</span>
<a name="l00059"></a>00059 <span class="comment"> */</span>
<a name="l00060"></a>00060 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1ethernet.html#a5efc1935f87339afeee213b19aea46c7" title="attach packet filter to socket to restrict which packets read sees.">attach_pktfilter</a> (<a class="code" href="classusrp2_1_1pktfilter.html">pktfilter</a> *pf);
<a name="l00061"></a>00061 <span class="comment"></span>
<a name="l00062"></a>00062 <span class="comment"> /*!</span>
<a name="l00063"></a>00063 <span class="comment"> * \brief return 6 byte string containing our MAC address</span>
<a name="l00064"></a>00064 <span class="comment"> */</span>
<a name="l00065"></a><a class="code" href="classusrp2_1_1ethernet.html#a34eb36ab2061627465ab3784a58c02e4">00065</a> <span class="keyword">const</span> uint8_t *<a class="code" href="classusrp2_1_1ethernet.html#a34eb36ab2061627465ab3784a58c02e4" title="return 6 byte string containing our MAC address">mac</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_mac; }
<a name="l00066"></a>00066 <span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment"> /*!</span>
<a name="l00068"></a>00068 <span class="comment"> * \brief Return file descriptor associated with socket.</span>
<a name="l00069"></a>00069 <span class="comment"> */</span>
<a name="l00070"></a><a class="code" href="classusrp2_1_1ethernet.html#abf9839099d07ee2e27d55e3ffc92ec99">00070</a> <span class="keywordtype">int</span> <a class="code" href="classusrp2_1_1ethernet.html#abf9839099d07ee2e27d55e3ffc92ec99" title="Return file descriptor associated with socket.">fd</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_fd; }
<a name="l00071"></a>00071 <span class="comment"></span>
<a name="l00072"></a>00072 <span class="comment"> /*!</span>
<a name="l00073"></a>00073 <span class="comment"> * \brief Read packet from interface.</span>
<a name="l00074"></a>00074 <span class="comment"> *</span>
<a name="l00075"></a>00075 <span class="comment"> * \param buf where to put the packet</span>
<a name="l00076"></a>00076 <span class="comment"> * \param buflen maximum length of packet in bytes (should be >= 1528)</span>
<a name="l00077"></a>00077 <span class="comment"> *</span>
<a name="l00078"></a>00078 <span class="comment"> * \returns number of bytes read or -1 if trouble.</span>
<a name="l00079"></a>00079 <span class="comment"> *</span>
<a name="l00080"></a>00080 <span class="comment"> * Returned packet includes 14-byte ethhdr</span>
<a name="l00081"></a>00081 <span class="comment"> */</span>
<a name="l00082"></a>00082 <span class="keywordtype">int</span> <a class="code" href="classusrp2_1_1ethernet.html#a755e8345eb87bb07397b727bdee161f3" title="Read packet from interface.">read_packet</a> (<span class="keywordtype">void</span> *buf, <span class="keywordtype">int</span> buflen);
<a name="l00083"></a>00083 <span class="comment"></span>
<a name="l00084"></a>00084 <span class="comment"> /*!</span>
<a name="l00085"></a>00085 <span class="comment"> * \brief Read packet from interface, but don't block waiting</span>
<a name="l00086"></a>00086 <span class="comment"> *</span>
<a name="l00087"></a>00087 <span class="comment"> * \param buf where to put the packet</span>
<a name="l00088"></a>00088 <span class="comment"> * \param buflen maximum length of packet in bytes (should be >= 1528)</span>
<a name="l00089"></a>00089 <span class="comment"> *</span>
<a name="l00090"></a>00090 <span class="comment"> * \returns number of bytes read, -1 if trouble or 0 if nothing available.</span>
<a name="l00091"></a>00091 <span class="comment"> *</span>
<a name="l00092"></a>00092 <span class="comment"> * Returned packet includes 14-byte ethhdr</span>
<a name="l00093"></a>00093 <span class="comment"> */</span>
<a name="l00094"></a>00094 <span class="keywordtype">int</span> <a class="code" href="classusrp2_1_1ethernet.html#abb1065dad974e1d72e596129fc3b4f54" title="Read packet from interface, but don&#39;t block waiting.">read_packet_dont_block</a> (<span class="keywordtype">void</span> *buf, <span class="keywordtype">int</span> buflen);
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="comment">/*</span>
<a name="l00097"></a>00097 <span class="comment"> * \brief Write ethernet packet to interface.</span>
<a name="l00098"></a>00098 <span class="comment"> *</span>
<a name="l00099"></a>00099 <span class="comment"> * \param buf the packet to write</span>
<a name="l00100"></a>00100 <span class="comment"> * \param buflen length of packet in bytes</span>
<a name="l00101"></a>00101 <span class="comment"> *</span>
<a name="l00102"></a>00102 <span class="comment"> * \returns number of bytes written or -1 if trouble.</span>
<a name="l00103"></a>00103 <span class="comment"> *</span>
<a name="l00104"></a>00104 <span class="comment"> * Packet must begin with 14-byte ethhdr, but does not include the FCS.</span>
<a name="l00105"></a>00105 <span class="comment"> */</span>
<a name="l00106"></a>00106 <span class="keywordtype">int</span> <a class="code" href="classusrp2_1_1ethernet.html#a9deb0e174bd0a273070c46f1bddaceeb">write_packet</a> (<span class="keyword">const</span> <span class="keywordtype">void</span> *buf, <span class="keywordtype">int</span> buflen);
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="comment">/*</span>
<a name="l00109"></a>00109 <span class="comment"> * \brief Write ethernet packet to interface.</span>
<a name="l00110"></a>00110 <span class="comment"> *</span>
<a name="l00111"></a>00111 <span class="comment"> * \param iov scatter/gather array</span>
<a name="l00112"></a>00112 <span class="comment"> * \param iovlen number of elements in iov</span>
<a name="l00113"></a>00113 <span class="comment"> *</span>
<a name="l00114"></a>00114 <span class="comment"> * \returns number of bytes written or -1 if trouble.</span>
<a name="l00115"></a>00115 <span class="comment"> *</span>
<a name="l00116"></a>00116 <span class="comment"> * Packet must begin with 14-byte ethhdr, but does not include the FCS.</span>
<a name="l00117"></a>00117 <span class="comment"> */</span>
<a name="l00118"></a>00118 <span class="keywordtype">int</span> <a class="code" href="classusrp2_1_1ethernet.html#acd43b9c92c76c4e466b1d33945a6396d">write_packetv</a> (<span class="keyword">const</span> eth_iovec *iov, <span class="keywordtype">size_t</span> iovlen);
<a name="l00119"></a>00119
<a name="l00120"></a>00120 };
<a name="l00121"></a>00121
<a name="l00122"></a>00122 } <span class="comment">// namespace usrp2</span>
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_USRP2_ETHERNET_H */</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="ethernet_8h.html">ethernet.h</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
>
3220
