<!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: gr_udp_source.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('gr__udp__source_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>gr_udp_source.h</h1> </div>
</div>
<div class="contents">
<a href="gr__udp__source_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 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 file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef INCLUDED_GR_UDP_SOURCE_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_UDP_SOURCE_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <gr_sync_block.h></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <gnuradio/omnithread.h></span>
<a name="l00028"></a>00028 <span class="preprocessor">#if defined(HAVE_SOCKET)</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#include <sys/socket.h></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <arpa/inet.h></span>
<a name="l00031"></a>00031 <span class="preprocessor">#elif defined(HAVE_WINDOWS_H)</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#include <winsock2.h></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include <windows.h></span>
<a name="l00034"></a>00034 <span class="preprocessor">#endif</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span><span class="preprocessor">#if defined(HAVE_NETINET_IN_H)</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#include <netinet/in.h></span>
<a name="l00037"></a>00037 <span class="preprocessor">#endif</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span>
<a name="l00039"></a>00039 <span class="keyword">class </span><a class="code" href="classgr__udp__source.html" title="Read stream from an UDP socket.">gr_udp_source</a>;
<a name="l00040"></a>00040 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<gr_udp_source></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_udp_source_sptr</a>;
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_udp_source_sptr</a> <a class="code" href="gr__udp__source_8h.html#a07f54a9895adade91eca920d962f574d">gr_make_udp_source</a>(<span class="keywordtype">size_t</span> itemsize, <span class="keyword">const</span> <span class="keywordtype">char</span> *src,
<a name="l00043"></a>00043 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> port_src, <span class="keywordtype">int</span> <a class="code" href="classgr__udp__source.html#a09db2251d1f7406889104fb1e8aac0a0" title="return the PAYLOAD_SIZE of the socket">payload_size</a>=1472);
<a name="l00044"></a>00044 <span class="comment"></span>
<a name="l00045"></a>00045 <span class="comment">/*! </span>
<a name="l00046"></a>00046 <span class="comment"> * \brief Read stream from an UDP socket.</span>
<a name="l00047"></a>00047 <span class="comment"> * \ingroup source_blk</span>
<a name="l00048"></a>00048 <span class="comment"> *</span>
<a name="l00049"></a>00049 <span class="comment"> * \param itemsize The size (in bytes) of the item datatype</span>
<a name="l00050"></a>00050 <span class="comment"> * \param src The source address as either the host name or the 'numbers-and-dots'</span>
<a name="l00051"></a>00051 <span class="comment"> * IP address</span>
<a name="l00052"></a>00052 <span class="comment"> * \param port_src The port number on which the socket listens for data</span>
<a name="l00053"></a>00053 <span class="comment"> * \param payload_size UDP payload size by default set to </span>
<a name="l00054"></a>00054 <span class="comment"> * 1472 = (1500 MTU - (8 byte UDP header) - (20 byte IP header))</span>
<a name="l00055"></a>00055 <span class="comment"> *</span>
<a name="l00056"></a>00056 <span class="comment">*/</span>
<a name="l00057"></a>00057
<a name="l00058"></a><a class="code" href="classgr__udp__source.html">00058</a> <span class="keyword">class </span><a class="code" href="classgr__udp__source.html" title="Read stream from an UDP socket.">gr_udp_source</a> : <span class="keyword">public</span> <a class="code" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...">gr_sync_block</a>
<a name="l00059"></a>00059 {
<a name="l00060"></a>00060 <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_udp_source_sptr</a> <a class="code" href="classgr__udp__source.html#ae521546a5df55919736bbf4fcd21c421">gr_make_udp_source</a>(<span class="keywordtype">size_t</span> itemsize, <span class="keyword">const</span> <span class="keywordtype">char</span> *src,
<a name="l00061"></a>00061 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> port_src, <span class="keywordtype">int</span> <a class="code" href="classgr__udp__source.html#a09db2251d1f7406889104fb1e8aac0a0" title="return the PAYLOAD_SIZE of the socket">payload_size</a>);
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="keyword">private</span>:
<a name="l00064"></a>00064 <span class="keywordtype">size_t</span> d_itemsize;
<a name="l00065"></a>00065 <span class="keywordtype">bool</span> d_updated;
<a name="l00066"></a>00066 <a class="code" href="classomni__mutex.html">omni_mutex</a> d_mutex;
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="keywordtype">int</span> d_payload_size; <span class="comment">// maximum transmission unit (packet length)</span>
<a name="l00069"></a>00069 <span class="keywordtype">int</span> d_socket; <span class="comment">// handle to socket</span>
<a name="l00070"></a>00070 <span class="keywordtype">int</span> d_socket_rcv; <span class="comment">// handle to socket retuned in the accept call</span>
<a name="l00071"></a>00071 <span class="keyword">struct </span>in_addr d_ip_src; <span class="comment">// store the source IP address to use</span>
<a name="l00072"></a>00072 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> d_port_src; <span class="comment">// the port number to open for connections to this service</span>
<a name="l00073"></a>00073 <span class="keyword">struct </span>sockaddr_in d_sockaddr_src; <span class="comment">// store the source sockaddr data (formatted IP address and port number)</span>
<a name="l00074"></a>00074 <span class="keywordtype">char</span> *d_temp_buff; <span class="comment">// hold buffer between calls</span>
<a name="l00075"></a>00075 ssize_t d_residual; <span class="comment">// hold information about number of bytes stored in the temp buffer</span>
<a name="l00076"></a>00076 <span class="keywordtype">size_t</span> d_temp_offset; <span class="comment">// point to temp buffer location offset</span>
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="keyword">protected</span>:<span class="comment"></span>
<a name="l00079"></a>00079 <span class="comment"> /*!</span>
<a name="l00080"></a>00080 <span class="comment"> * \brief UDP Source Constructor</span>
<a name="l00081"></a>00081 <span class="comment"> * </span>
<a name="l00082"></a>00082 <span class="comment"> * \param itemsize The size (in bytes) of the item datatype</span>
<a name="l00083"></a>00083 <span class="comment"> * \param src The source address as either the host name or the 'numbers-and-dots'</span>
<a name="l00084"></a>00084 <span class="comment"> * IP address</span>
<a name="l00085"></a>00085 <span class="comment"> * \param port_src The port number on which the socket listens for data</span>
<a name="l00086"></a>00086 <span class="comment"> * \param payload_size UDP payload size by default set to </span>
<a name="l00087"></a>00087 <span class="comment"> * 1472 = (1500 MTU - (8 byte UDP header) - (20 byte IP header))</span>
<a name="l00088"></a>00088 <span class="comment"> */</span>
<a name="l00089"></a>00089 <a class="code" href="classgr__udp__source.html#a61928d229b532ddb8c570fec8eef741d" title="UDP Source Constructor.">gr_udp_source</a>(<span class="keywordtype">size_t</span> itemsize, <span class="keyword">const</span> <span class="keywordtype">char</span> *src, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> port_src, <span class="keywordtype">int</span> payload_size);
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="keyword">public</span>:
<a name="l00092"></a>00092 <a class="code" href="classgr__udp__source.html#aff679a619371a151f8f037eb8c206bb5">~gr_udp_source</a>();
<a name="l00093"></a>00093 <span class="comment"></span>
<a name="l00094"></a>00094 <span class="comment"> /*!</span>
<a name="l00095"></a>00095 <span class="comment"> * \brief open a socket specified by the port and ip address info</span>
<a name="l00096"></a>00096 <span class="comment"> *</span>
<a name="l00097"></a>00097 <span class="comment"> * Opens a socket, binds to the address, and waits for a connection</span>
<a name="l00098"></a>00098 <span class="comment"> * over UDP. If any of these fail, the fuction retuns the error and exits.</span>
<a name="l00099"></a>00099 <span class="comment"> */</span>
<a name="l00100"></a>00100 <span class="keywordtype">bool</span> <a class="code" href="classgr__udp__source.html#aae7f8736725b5dcd638659f19166c018" title="open a socket specified by the port and ip address info">open</a>();
<a name="l00101"></a>00101 <span class="comment"></span>
<a name="l00102"></a>00102 <span class="comment"> /*!</span>
<a name="l00103"></a>00103 <span class="comment"> * \brief Close current socket.</span>
<a name="l00104"></a>00104 <span class="comment"> *</span>
<a name="l00105"></a>00105 <span class="comment"> * Shuts down read/write on the socket</span>
<a name="l00106"></a>00106 <span class="comment"> */</span>
<a name="l00107"></a>00107 <span class="keywordtype">void</span> <a class="code" href="classgr__udp__source.html#aa47a4308b57f48b6872505863106566c" title="Close current socket.">close</a>();
<a name="l00108"></a>00108 <span class="comment"></span>
<a name="l00109"></a>00109 <span class="comment"> /*! \brief return the PAYLOAD_SIZE of the socket */</span>
<a name="l00110"></a><a class="code" href="classgr__udp__source.html#a09db2251d1f7406889104fb1e8aac0a0">00110</a> <span class="keywordtype">int</span> <a class="code" href="classgr__udp__source.html#a09db2251d1f7406889104fb1e8aac0a0" title="return the PAYLOAD_SIZE of the socket">payload_size</a>() { <span class="keywordflow">return</span> d_payload_size; }
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="comment">// should we export anything else?</span>
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="keywordtype">int</span> <a class="code" href="classgr__udp__source.html#aafcc18df4c9ed93551dde48cce610f4e" title="just like gr_block::general_work, only this arranges to call consume_each for you">work</a>(<span class="keywordtype">int</span> noutput_items,
<a name="l00115"></a>00115 <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items,
<a name="l00116"></a>00116 <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items);
<a name="l00117"></a>00117 };
<a name="l00118"></a>00118
<a name="l00119"></a>00119
<a name="l00120"></a>00120 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GR_UDP_SOURCE_H */</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="gr__udp__source_8h.html">gr_udp_source.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>
