<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>DTN Reference Implementation: dtn::UDPConvergenceLayer::Sender Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespacedtn.html">dtn</a>::<a class="el" href="classdtn_1_1UDPConvergenceLayer.html">UDPConvergenceLayer</a>::<a class="el" href="classdtn_1_1UDPConvergenceLayer_1_1Sender.html">Sender</a>
</div>
</div>
<div class="contents">
<h1>dtn::UDPConvergenceLayer::Sender Class Reference</h1><!-- doxytag: class="dtn::UDPConvergenceLayer::Sender" --><!-- doxytag: inherits="dtn::CLInfo,oasys::Logger" --><code>#include <<a class="el" href="UDPConvergenceLayer_8h-source.html">UDPConvergenceLayer.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for dtn::UDPConvergenceLayer::Sender:</div>
<div class="dynsection">
<p><center><img src="classdtn_1_1UDPConvergenceLayer_1_1Sender.png" usemap="#dtn::UDPConvergenceLayer::Sender_map" border="0" alt=""></center>
<map name="dtn::UDPConvergenceLayer::Sender_map">
<area href="classdtn_1_1CLInfo.html" alt="dtn::CLInfo" shape="rect" coords="0,0,217,24">
<area href="classoasys_1_1Logger.html" alt="Logger" shape="rect" coords="227,0,444,24">
</map>
</div>
<p>
<a href="classdtn_1_1UDPConvergenceLayer_1_1Sender-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="UDPConvergenceLayer_8h-source.html#l00166">166</a> of file <a class="el" href="UDPConvergenceLayer_8h-source.html">UDPConvergenceLayer.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1UDPConvergenceLayer_1_1Sender.html#cb0f30b3e53feea00eee5cab6d5ab643">~Sender</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#cb0f30b3e53feea00eee5cab6d5ab643"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1UDPConvergenceLayer_1_1Sender.html#c6315762354be592f3706ab4625d6f2a">init</a> (<a class="el" href="classdtn_1_1UDPConvergenceLayer_1_1Params.html">Params</a> *params, in_addr_t addr, u_int16_t port)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the sender (the "real" constructor). <a href="#c6315762354be592f3706ab4625d6f2a"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1UDPConvergenceLayer_1_1Sender.html#b3d4e978b3bcd7e0acf9d1317ec573a5">Sender</a> (const <a class="el" href="namespacedtn.html#5f869544c85c75b5a85a14d6e90d7ff7">ContactRef</a> &contact)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#b3d4e978b3bcd7e0acf9d1317ec573a5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1UDPConvergenceLayer_1_1Sender.html#91a88f720ab7bce40b253bdf99da4041">send_bundle</a> (const <a class="el" href="namespacedtn.html#87094f3b26b9f1d469e616d311ae57b1">BundleRef</a> &bundle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send one bundle. <a href="#91a88f720ab7bce40b253bdf99da4041"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classdtn_1_1UDPConvergenceLayer_1_1Params.html">Params</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1UDPConvergenceLayer_1_1Sender.html#f9924f6f1b6a5239785e44f1fdbfa88c">params_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the link parameters. <a href="#f9924f6f1b6a5239785e44f1fdbfa88c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">oasys::UDPClient </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1UDPConvergenceLayer_1_1Sender.html#175508dde272895c68433f22a8608e79">socket_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The udp client socket. <a href="#175508dde272895c68433f22a8608e79"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">oasys::RateLimitedSocket </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1UDPConvergenceLayer_1_1Sender.html#c2187f087794893d671604031170a45d">rate_socket_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Rate-limited socket that's optionally enabled. <a href="#c2187f087794893d671604031170a45d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespacedtn.html#5f869544c85c75b5a85a14d6e90d7ff7">ContactRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1UDPConvergenceLayer_1_1Sender.html#ddd3e4252cd3a35f7fe463531f0ea6e2">contact_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The contact that we're representing. <a href="#ddd3e4252cd3a35f7fe463531f0ea6e2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u_char </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1UDPConvergenceLayer_1_1Sender.html#f5f9512e644cfd522c2ba2a99d629363">buf_</a> [<a class="el" href="classdtn_1_1UDPConvergenceLayer.html#76e985ed36150909b585c14e3c14c242">UDPConvergenceLayer::MAX_BUNDLE_LEN</a>]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Temporary buffer for formatting bundles. <a href="#f5f9512e644cfd522c2ba2a99d629363"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1UDPConvergenceLayer_1_1Sender.html#0e2cc2c21955a758513e1356e5e0a62c">UDPConvergenceLayer</a></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="cb0f30b3e53feea00eee5cab6d5ab643"></a><!-- doxytag: member="dtn::UDPConvergenceLayer::Sender::~Sender" ref="cb0f30b3e53feea00eee5cab6d5ab643" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual dtn::UDPConvergenceLayer::Sender::~Sender </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
<p>Definition at line <a class="el" href="UDPConvergenceLayer_8h-source.html#l00171">171</a> of file <a class="el" href="UDPConvergenceLayer_8h-source.html">UDPConvergenceLayer.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="b3d4e978b3bcd7e0acf9d1317ec573a5"></a><!-- doxytag: member="dtn::UDPConvergenceLayer::Sender::Sender" ref="b3d4e978b3bcd7e0acf9d1317ec573a5" args="(const ContactRef &contact)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dtn::UDPConvergenceLayer::Sender::Sender </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacedtn.html#5f869544c85c75b5a85a14d6e90d7ff7">ContactRef</a> & </td>
<td class="paramname"> <em>contact</em> </td>
<td> ) </td>
<td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
<p>Definition at line <a class="el" href="UDPConvergenceLayer_8cc-source.html#l00419">419</a> of file <a class="el" href="UDPConvergenceLayer_8cc-source.html">UDPConvergenceLayer.cc</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c6315762354be592f3706ab4625d6f2a"></a><!-- doxytag: member="dtn::UDPConvergenceLayer::Sender::init" ref="c6315762354be592f3706ab4625d6f2a" args="(Params *params, in_addr_t addr, u_int16_t port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> dtn::UDPConvergenceLayer::Sender::init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classdtn_1_1UDPConvergenceLayer_1_1Params.html">Params</a> * </td>
<td class="paramname"> <em>params</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in_addr_t </td>
<td class="paramname"> <em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u_int16_t </td>
<td class="paramname"> <em>port</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize the sender (the "real" constructor).
<p>
<p>Definition at line <a class="el" href="UDPConvergenceLayer_8cc-source.html#l00430">430</a> of file <a class="el" href="UDPConvergenceLayer_8cc-source.html">UDPConvergenceLayer.cc</a>.</p>
<p>References <a class="el" href="UDPConvergenceLayer_8h-source.html#l00113">dtn::UDPConvergenceLayer::Params::bucket_depth_</a>, <a class="el" href="IPDiscovery_8cc.html#d65a8842cc674e3ddf69355898c0ecbf">errno</a>, <a class="el" href="UDPConvergenceLayer_8h-source.html#l00107">dtn::UDPConvergenceLayer::Params::local_addr_</a>, <a class="el" href="UDPConvergenceLayer_8h-source.html#l00108">dtn::UDPConvergenceLayer::Params::local_port_</a>, <a class="el" href="UDPConvergenceLayer_8h-source.html#l00195">params_</a>, <a class="el" href="UDPConvergenceLayer_8h-source.html#l00112">dtn::UDPConvergenceLayer::Params::rate_</a>, <a class="el" href="UDPConvergenceLayer_8h-source.html#l00205">rate_socket_</a>, and <a class="el" href="UDPConvergenceLayer_8h-source.html#l00200">socket_</a>.</p>
<p>Referenced by <a class="el" href="UDPConvergenceLayer_8cc-source.html#l00253">dtn::UDPConvergenceLayer::open_contact()</a>.</p>
</div>
</div><p>
<a class="anchor" name="91a88f720ab7bce40b253bdf99da4041"></a><!-- doxytag: member="dtn::UDPConvergenceLayer::Sender::send_bundle" ref="91a88f720ab7bce40b253bdf99da4041" args="(const BundleRef &bundle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dtn::UDPConvergenceLayer::Sender::send_bundle </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacedtn.html#87094f3b26b9f1d469e616d311ae57b1">BundleRef</a> & </td>
<td class="paramname"> <em>bundle</em> </td>
<td> ) </td>
<td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Send one bundle.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the length of the bundle sent or -1 on error </dd></dl>
<p>Definition at line <a class="el" href="UDPConvergenceLayer_8cc-source.html#l00474">474</a> of file <a class="el" href="UDPConvergenceLayer_8cc-source.html">UDPConvergenceLayer.cc</a>.</p>
<p>References <a class="el" href="SDNV_8cc-source.html#l00044">ASSERT</a>, <a class="el" href="UDPConvergenceLayer_8h-source.html#l00217">buf_</a>, <a class="el" href="UDPConvergenceLayer_8h-source.html#l00210">contact_</a>, <a class="el" href="IPDiscovery_8cc.html#d65a8842cc674e3ddf69355898c0ecbf">errno</a>, <a class="el" href="UDPConvergenceLayer_8h-source.html#l00033">dtn::UDPConvergenceLayer::MAX_BUNDLE_LEN</a>, <a class="el" href="BundleProtocol_8cc-source.html#l00299">dtn::BundleProtocol::produce()</a>, <a class="el" href="UDPConvergenceLayer_8h-source.html#l00200">socket_</a>, and <a class="el" href="BundleProtocol_8cc-source.html#l00264">dtn::BundleProtocol::total_length()</a>.</p>
<p>Referenced by <a class="el" href="UDPConvergenceLayer_8cc-source.html#l00325">dtn::UDPConvergenceLayer::bundle_queued()</a>.</p>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="0e2cc2c21955a758513e1356e5e0a62c"></a><!-- doxytag: member="dtn::UDPConvergenceLayer::Sender::UDPConvergenceLayer" ref="0e2cc2c21955a758513e1356e5e0a62c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classdtn_1_1UDPConvergenceLayer.html">UDPConvergenceLayer</a><code> [friend]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="UDPConvergenceLayer_8h-source.html#l00179">179</a> of file <a class="el" href="UDPConvergenceLayer_8h-source.html">UDPConvergenceLayer.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="f9924f6f1b6a5239785e44f1fdbfa88c"></a><!-- doxytag: member="dtn::UDPConvergenceLayer::Sender::params_" ref="f9924f6f1b6a5239785e44f1fdbfa88c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdtn_1_1UDPConvergenceLayer_1_1Params.html">Params</a>* <a class="el" href="classdtn_1_1UDPConvergenceLayer_1_1Sender.html#f9924f6f1b6a5239785e44f1fdbfa88c">dtn::UDPConvergenceLayer::Sender::params_</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Pointer to the link parameters.
<p>
<p>Definition at line <a class="el" href="UDPConvergenceLayer_8h-source.html#l00195">195</a> of file <a class="el" href="UDPConvergenceLayer_8h-source.html">UDPConvergenceLayer.h</a>.</p>
<p>Referenced by <a class="el" href="UDPConvergenceLayer_8cc-source.html#l00430">init()</a>.</p>
</div>
</div><p>
<a class="anchor" name="175508dde272895c68433f22a8608e79"></a><!-- doxytag: member="dtn::UDPConvergenceLayer::Sender::socket_" ref="175508dde272895c68433f22a8608e79" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">oasys::UDPClient <a class="el" href="classdtn_1_1UDPConvergenceLayer_1_1Sender.html#175508dde272895c68433f22a8608e79">dtn::UDPConvergenceLayer::Sender::socket_</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The udp client socket.
<p>
<p>Definition at line <a class="el" href="UDPConvergenceLayer_8h-source.html#l00200">200</a> of file <a class="el" href="UDPConvergenceLayer_8h-source.html">UDPConvergenceLayer.h</a>.</p>
<p>Referenced by <a class="el" href="UDPConvergenceLayer_8cc-source.html#l00430">init()</a>, and <a class="el" href="UDPConvergenceLayer_8cc-source.html#l00474">send_bundle()</a>.</p>
</div>
</div><p>
<a class="anchor" name="c2187f087794893d671604031170a45d"></a><!-- doxytag: member="dtn::UDPConvergenceLayer::Sender::rate_socket_" ref="c2187f087794893d671604031170a45d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">oasys::RateLimitedSocket <a class="el" href="classdtn_1_1UDPConvergenceLayer_1_1Sender.html#c2187f087794893d671604031170a45d">dtn::UDPConvergenceLayer::Sender::rate_socket_</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Rate-limited socket that's optionally enabled.
<p>
<p>Definition at line <a class="el" href="UDPConvergenceLayer_8h-source.html#l00205">205</a> of file <a class="el" href="UDPConvergenceLayer_8h-source.html">UDPConvergenceLayer.h</a>.</p>
<p>Referenced by <a class="el" href="UDPConvergenceLayer_8cc-source.html#l00430">init()</a>.</p>
</div>
</div><p>
<a class="anchor" name="ddd3e4252cd3a35f7fe463531f0ea6e2"></a><!-- doxytag: member="dtn::UDPConvergenceLayer::Sender::contact_" ref="ddd3e4252cd3a35f7fe463531f0ea6e2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacedtn.html#5f869544c85c75b5a85a14d6e90d7ff7">ContactRef</a> <a class="el" href="classdtn_1_1UDPConvergenceLayer_1_1Sender.html#ddd3e4252cd3a35f7fe463531f0ea6e2">dtn::UDPConvergenceLayer::Sender::contact_</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The contact that we're representing.
<p>
<p>Definition at line <a class="el" href="UDPConvergenceLayer_8h-source.html#l00210">210</a> of file <a class="el" href="UDPConvergenceLayer_8h-source.html">UDPConvergenceLayer.h</a>.</p>
<p>Referenced by <a class="el" href="UDPConvergenceLayer_8cc-source.html#l00325">dtn::UDPConvergenceLayer::bundle_queued()</a>, and <a class="el" href="UDPConvergenceLayer_8cc-source.html#l00474">send_bundle()</a>.</p>
</div>
</div><p>
<a class="anchor" name="f5f9512e644cfd522c2ba2a99d629363"></a><!-- doxytag: member="dtn::UDPConvergenceLayer::Sender::buf_" ref="f5f9512e644cfd522c2ba2a99d629363" args="[UDPConvergenceLayer::MAX_BUNDLE_LEN]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u_char <a class="el" href="classdtn_1_1UDPConvergenceLayer_1_1Sender.html#f5f9512e644cfd522c2ba2a99d629363">dtn::UDPConvergenceLayer::Sender::buf_</a>[<a class="el" href="classdtn_1_1UDPConvergenceLayer.html#76e985ed36150909b585c14e3c14c242">UDPConvergenceLayer::MAX_BUNDLE_LEN</a>]<code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Temporary buffer for formatting bundles.
<p>
Note that the fixed-length buffer is big enough since UDP packets can't be any bigger than that.
<p>Definition at line <a class="el" href="UDPConvergenceLayer_8h-source.html#l00217">217</a> of file <a class="el" href="UDPConvergenceLayer_8h-source.html">UDPConvergenceLayer.h</a>.</p>
<p>Referenced by <a class="el" href="UDPConvergenceLayer_8cc-source.html#l00474">send_bundle()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="UDPConvergenceLayer_8h-source.html">UDPConvergenceLayer.h</a><li><a class="el" href="UDPConvergenceLayer_8cc-source.html">UDPConvergenceLayer.cc</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jul 21 14:09:52 2008 for DTN Reference Implementation by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
