<!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.3.0 C++ API: gr_udp_sink.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<h1>gr_udp_sink.h</h1><a href="gr__udp__sink_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,2009,2010 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_SINK_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_UDP_SINK_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <<a class="code" href="gr__sync__block_8h.html">gr_sync_block.h</a>></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <<a class="code" href="thread_8h.html">gruel/thread.h</a>></span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">class </span><a class="code" href="classgr__udp__sink.html" title="Write stream to an UDP socket.">gr_udp_sink</a>;
<a name="l00030"></a>00030 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<gr_udp_sink></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_udp_sink_sptr</a>;
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_udp_sink_sptr</a>
<a name="l00033"></a>00033 <a class="code" href="gr__udp__sink_8h.html#a7816f6d647ce9605902dbc44a1f29f72">gr_make_udp_sink</a> (<span class="keywordtype">size_t</span> itemsize,
<a name="l00034"></a>00034 <span class="keyword">const</span> <span class="keywordtype">char</span> *host, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> port,
<a name="l00035"></a>00035 <span class="keywordtype">int</span> <a class="code" href="classgr__udp__sink.html#addfd364e9a400b77ba69760c12c6d00e" title="return the PAYLOAD_SIZE of the socket">payload_size</a>=1472, <span class="keywordtype">bool</span> eof=<span class="keyword">true</span>);
<a name="l00036"></a>00036 <span class="comment"></span>
<a name="l00037"></a>00037 <span class="comment">/*!</span>
<a name="l00038"></a>00038 <span class="comment"> * \brief Write stream to an UDP socket.</span>
<a name="l00039"></a>00039 <span class="comment"> * \ingroup sink_blk</span>
<a name="l00040"></a>00040 <span class="comment"> * </span>
<a name="l00041"></a>00041 <span class="comment"> * \param itemsize The size (in bytes) of the item datatype</span>
<a name="l00042"></a>00042 <span class="comment"> * \param host The name or IP address of the receiving host; use</span>
<a name="l00043"></a>00043 <span class="comment"> * NULL or None for no connection</span>
<a name="l00044"></a>00044 <span class="comment"> * \param port Destination port to connect to on receiving host</span>
<a name="l00045"></a>00045 <span class="comment"> * \param payload_size UDP payload size by default set to 1472 =</span>
<a name="l00046"></a>00046 <span class="comment"> * (1500 MTU - (8 byte UDP header) - (20 byte IP header))</span>
<a name="l00047"></a>00047 <span class="comment"> * \param eof Send zero-length packet on disconnect</span>
<a name="l00048"></a>00048 <span class="comment"> */</span>
<a name="l00049"></a>00049
<a name="l00050"></a><a class="code" href="classgr__udp__sink.html">00050</a> <span class="keyword">class </span><a class="code" href="classgr__udp__sink.html" title="Write stream to an UDP socket.">gr_udp_sink</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...">gr_sync_block</a>
<a name="l00051"></a>00051 {
<a name="l00052"></a>00052 <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_udp_sink_sptr</a> <a class="code" href="classgr__udp__sink.html#ae612e6c7dc6bf82e840586193213492a">gr_make_udp_sink</a> (<span class="keywordtype">size_t</span> itemsize,
<a name="l00053"></a>00053 <span class="keyword">const</span> <span class="keywordtype">char</span> *host,
<a name="l00054"></a>00054 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> port,
<a name="l00055"></a>00055 <span class="keywordtype">int</span> <a class="code" href="classgr__udp__sink.html#addfd364e9a400b77ba69760c12c6d00e" title="return the PAYLOAD_SIZE of the socket">payload_size</a>, <span class="keywordtype">bool</span> eof);
<a name="l00056"></a>00056 <span class="keyword">private</span>:
<a name="l00057"></a>00057 <span class="keywordtype">size_t</span> d_itemsize;
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="keywordtype">int</span> d_payload_size; <span class="comment">// maximum transmission unit (packet length)</span>
<a name="l00060"></a>00060 <span class="keywordtype">bool</span> d_eof; <span class="comment">// send zero-length packet on disconnect</span>
<a name="l00061"></a>00061 <span class="keywordtype">int</span> d_socket; <span class="comment">// handle to socket</span>
<a name="l00062"></a>00062 <span class="keywordtype">bool</span> d_connected; <span class="comment">// are we connected?</span>
<a name="l00063"></a>00063 gruel::mutex d_mutex; <span class="comment">// protects d_socket and d_connected</span>
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="keyword">protected</span>:<span class="comment"></span>
<a name="l00066"></a>00066 <span class="comment"> /*!</span>
<a name="l00067"></a>00067 <span class="comment"> * \brief UDP Sink Constructor</span>
<a name="l00068"></a>00068 <span class="comment"> * </span>
<a name="l00069"></a>00069 <span class="comment"> * \param itemsize The size (in bytes) of the item datatype</span>
<a name="l00070"></a>00070 <span class="comment"> * \param host The name or IP address of the receiving host; use</span>
<a name="l00071"></a>00071 <span class="comment"> * NULL or None for no connection</span>
<a name="l00072"></a>00072 <span class="comment"> * \param port Destination port to connect to on receiving host</span>
<a name="l00073"></a>00073 <span class="comment"> * \param payload_size UDP payload size by default set to </span>
<a name="l00074"></a>00074 <span class="comment"> * 1472 = (1500 MTU - (8 byte UDP header) - (20 byte IP header))</span>
<a name="l00075"></a>00075 <span class="comment"> * \param eof Send zero-length packet on disconnect</span>
<a name="l00076"></a>00076 <span class="comment"> */</span>
<a name="l00077"></a>00077 <a class="code" href="classgr__udp__sink.html#ae4b83142ce76a6eb2319a6d56f3af0c7" title="UDP Sink Constructor.">gr_udp_sink</a> (<span class="keywordtype">size_t</span> itemsize,
<a name="l00078"></a>00078 <span class="keyword">const</span> <span class="keywordtype">char</span> *host, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> port,
<a name="l00079"></a>00079 <span class="keywordtype">int</span> payload_size, <span class="keywordtype">bool</span> eof);
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <span class="keyword">public</span>:
<a name="l00082"></a>00082 <a class="code" href="classgr__udp__sink.html#a1fd45dbaa9f28e948c0db03c2fe5e6e9">~gr_udp_sink</a> ();
<a name="l00083"></a>00083 <span class="comment"></span>
<a name="l00084"></a>00084 <span class="comment"> /*! \brief return the PAYLOAD_SIZE of the socket */</span>
<a name="l00085"></a><a class="code" href="classgr__udp__sink.html#addfd364e9a400b77ba69760c12c6d00e">00085</a> <span class="keywordtype">int</span> <a class="code" href="classgr__udp__sink.html#addfd364e9a400b77ba69760c12c6d00e" title="return the PAYLOAD_SIZE of the socket">payload_size</a>() { <span class="keywordflow">return</span> d_payload_size; }
<a name="l00086"></a>00086 <span class="comment"></span>
<a name="l00087"></a>00087 <span class="comment"> /*! \brief Change the connection to a new destination</span>
<a name="l00088"></a>00088 <span class="comment"> *</span>
<a name="l00089"></a>00089 <span class="comment"> * \param host The name or IP address of the receiving host; use</span>
<a name="l00090"></a>00090 <span class="comment"> * NULL or None to break the connection without closing</span>
<a name="l00091"></a>00091 <span class="comment"> * \param port Destination port to connect to on receiving host</span>
<a name="l00092"></a>00092 <span class="comment"> *</span>
<a name="l00093"></a>00093 <span class="comment"> * Calls disconnect() to terminate any current connection first.</span>
<a name="l00094"></a>00094 <span class="comment"> */</span>
<a name="l00095"></a>00095 <span class="keywordtype">void</span> <a class="code" href="classgr__udp__sink.html#ab93f39c0613a88896cdc0f23fc02f339" title="Change the connection to a new destination.">connect</a>( <span class="keyword">const</span> <span class="keywordtype">char</span> *host, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> port );
<a name="l00096"></a>00096 <span class="comment"></span>
<a name="l00097"></a>00097 <span class="comment"> /*! \brief Send zero-length packet (if eof is requested) then stop sending</span>
<a name="l00098"></a>00098 <span class="comment"> *</span>
<a name="l00099"></a>00099 <span class="comment"> * Zero-byte packets can be interpreted as EOF by gr_udp_source. Note that</span>
<a name="l00100"></a>00100 <span class="comment"> * disconnect occurs automatically when the sink is destroyed, but not when</span>
<a name="l00101"></a>00101 <span class="comment"> * its top_block stops.*/</span>
<a name="l00102"></a>00102 <span class="keywordtype">void</span> <a class="code" href="classgr__udp__sink.html#a5fac74580b0dc7cf3e7fac7b87d3c7cb" title="Send zero-length packet (if eof is requested) then stop sending.">disconnect</a>();
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <span class="comment">// should we export anything else?</span>
<a name="l00105"></a>00105
<a name="l00106"></a>00106 <span class="keywordtype">int</span> <a class="code" href="classgr__udp__sink.html#a5666786f59846c3c2984f4576060ff66" 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="l00107"></a>00107 <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items,
<a name="l00108"></a>00108 <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items);
<a name="l00109"></a>00109 };
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GR_UDP_SINK_H */</span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:51:01 2010 for GNU Radio 3.3.0 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
