<!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_sink 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('classgr__udp__sink.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<h1>gr_udp_sink Class Reference<div class="ingroups"><a class="el" href="group__sink__blk.html">Signal Sinks</a></div></h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="gr_udp_sink" --><!-- doxytag: inherits="gr_sync_block" -->
<p>Write stream to an UDP socket.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__udp__sink_8h_source.html">gr_udp_sink.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_udp_sink:</div>
<div class="dyncontent">
<div class="center"><img src="classgr__udp__sink__inherit__graph.png" border="0" usemap="#gr__udp__sink_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__udp__sink_inherit__map" id="gr__udp__sink_inherit__map">
<area shape="rect" id="node2" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa..." alt="" coords="7,160,113,189"/><area shape="rect" id="node4" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing flow is cons..." alt="" coords="25,83,95,112"/><area shape="rect" id="node6" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare abstraction of an ..." alt="" coords="5,5,115,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__udp__sink-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="classgr__udp__sink.html#a1fd45dbaa9f28e948c0db03c2fe5e6e9">~gr_udp_sink</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="classgr__udp__sink.html#acebde4b213c834fa2f28ddb5a75d2924">open</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">open a socket specified by the port and ip address info <a href="#acebde4b213c834fa2f28ddb5a75d2924"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__udp__sink.html#a02732719601faa9c0c21ae289770f981">close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close current socket. <a href="#a02732719601faa9c0c21ae289770f981"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__udp__sink.html#addfd364e9a400b77ba69760c12c6d00e">payload_size</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the PAYLOAD_SIZE of the socket <a href="#addfd364e9a400b77ba69760c12c6d00e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__udp__sink.html#a5666786f59846c3c2984f4576060ff66">work</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">just like <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you <a href="#a5666786f59846c3c2984f4576060ff66"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__udp__sink.html#ac9d91de2d47821f2879f7f5a9638f5ef">gr_udp_sink</a> (size_t itemsize, const char *src, unsigned short port_src, const char *dst, unsigned short port_dst, int payload_size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">UDP Sink Constructor. <a href="#ac9d91de2d47821f2879f7f5a9638f5ef"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_udp_sink_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__udp__sink.html#ab143f8d69c52a1dd9c17d811d5d568a9">gr_make_udp_sink</a> (size_t itemsize, const char *src, unsigned short port_src, const char *dst, unsigned short port_dst, int payload_size)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Write stream to an UDP socket. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">itemsize</td><td>The size (in bytes) of the item datatype </td></tr>
<tr><td class="paramname">src</td><td>The source address as either the host name or the 'numbers-and-dots' IP address </td></tr>
<tr><td class="paramname">port_src</td><td>Destination port to bind to (0 allows socket to choose an appropriate port) </td></tr>
<tr><td class="paramname">dst</td><td>The destination address as either the host name or the 'numbers-and-dots' IP address </td></tr>
<tr><td class="paramname">port_dst</td><td>Destination port to connect to </td></tr>
<tr><td class="paramname">payload_size</td><td>UDP payload size by default set to 1472 = (1500 MTU - (8 byte UDP header) - (20 byte IP header)) </td></tr>
</table>
</dd>
</dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac9d91de2d47821f2879f7f5a9638f5ef"></a><!-- doxytag: member="gr_udp_sink::gr_udp_sink" ref="ac9d91de2d47821f2879f7f5a9638f5ef" args="(size_t itemsize, const char *src, unsigned short port_src, const char *dst, unsigned short port_dst, int payload_size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_udp_sink::gr_udp_sink </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>itemsize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short </td>
<td class="paramname"><em>port_src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short </td>
<td class="paramname"><em>port_dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>payload_size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>UDP Sink Constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">itemsize</td><td>The size (in bytes) of the item datatype </td></tr>
<tr><td class="paramname">src</td><td>The source address as either the host name or the 'numbers-and-dots' IP address </td></tr>
<tr><td class="paramname">port_src</td><td>Destination port to bind to (0 allows socket to choose an appropriate port) </td></tr>
<tr><td class="paramname">dst</td><td>The destination address as either the host name or the 'numbers-and-dots' IP address </td></tr>
<tr><td class="paramname">port_dst</td><td>Destination port to connect to </td></tr>
<tr><td class="paramname">payload_size</td><td>UDP payload size by default set to 1472 = (1500 MTU - (8 byte UDP header) - (20 byte IP header)) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1fd45dbaa9f28e948c0db03c2fe5e6e9"></a><!-- doxytag: member="gr_udp_sink::~gr_udp_sink" ref="a1fd45dbaa9f28e948c0db03c2fe5e6e9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_udp_sink::~gr_udp_sink </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="a02732719601faa9c0c21ae289770f981"></a><!-- doxytag: member="gr_udp_sink::close" ref="a02732719601faa9c0c21ae289770f981" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_udp_sink::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close current socket. </p>
<p>Shuts down read/write on the socket </p>
</div>
</div>
<a class="anchor" id="acebde4b213c834fa2f28ddb5a75d2924"></a><!-- doxytag: member="gr_udp_sink::open" ref="acebde4b213c834fa2f28ddb5a75d2924" 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> gr_udp_sink::open </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>open a socket specified by the port and ip address info </p>
<p>Opens a socket, binds to the address, and makes connectionless association over UDP. If any of these fail, the fuction retuns the error and exits. </p>
</div>
</div>
<a class="anchor" id="addfd364e9a400b77ba69760c12c6d00e"></a><!-- doxytag: member="gr_udp_sink::payload_size" ref="addfd364e9a400b77ba69760c12c6d00e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_udp_sink::payload_size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return the PAYLOAD_SIZE of the socket </p>
</div>
</div>
<a class="anchor" id="a5666786f59846c3c2984f4576060ff66"></a><!-- doxytag: member="gr_udp_sink::work" ref="a5666786f59846c3c2984f4576060ff66" args="(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_udp_sink::work </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>noutput_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> & </td>
<td class="paramname"><em>input_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> & </td>
<td class="paramname"><em>output_items</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>just like <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you </p>
<p>The user must override work to define the signal processing code </p>
<p>Implements <a class="el" href="classgr__sync__block.html#a0c523f4285a6eb690f677ee6295ab117">gr_sync_block</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="ab143f8d69c52a1dd9c17d811d5d568a9"></a><!-- doxytag: member="gr_udp_sink::gr_make_udp_sink" ref="ab143f8d69c52a1dd9c17d811d5d568a9" args="(size_t itemsize, const char *src, unsigned short port_src, const char *dst, unsigned short port_dst, int payload_size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_udp_sink_sptr</a> gr_make_udp_sink </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>itemsize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short </td>
<td class="paramname"><em>port_src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short </td>
<td class="paramname"><em>port_dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>payload_size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [friend]</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="gr__udp__sink_8h_source.html">gr_udp_sink.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classgr__udp__sink.html">gr_udp_sink</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
>
2115
