<!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::BlockingBundleList 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_1BlockingBundleList.html">BlockingBundleList</a>
</div>
</div>
<div class="contents">
<h1>dtn::BlockingBundleList Class Reference</h1><!-- doxytag: class="dtn::BlockingBundleList" --><!-- doxytag: inherits="dtn::BundleList" --><code>#include <<a class="el" href="bundling_2BundleList_8h-source.html">BundleList.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for dtn::BlockingBundleList:</div>
<div class="dynsection">
<p><center><img src="classdtn_1_1BlockingBundleList.png" usemap="#dtn::BlockingBundleList_map" border="0" alt=""></center>
<map name="dtn::BlockingBundleList_map">
<area href="classdtn_1_1BundleList.html" alt="dtn::BundleList" shape="rect" coords="0,0,141,24">
</map>
</div>
<p>
<a href="classdtn_1_1BlockingBundleList-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
A simple derivative to the <a class="el" href="classdtn_1_1BundleList.html" title="List structure for handling bundles.">BundleList</a> class that hooks in an <a class="el" href="namespaceoasys.html">oasys</a> Notifier, which thereby allows inter-thread signalling via a <a class="el" href="classdtn_1_1BlockingBundleList.html#e26c8fce019eb0062f0cff1a03f4e2a3" title="Remove (and return) the first bundle on the list, blocking (potentially limited by...">pop_blocking()</a> method.
<p>
This allows one thread to block until another has added a bundle to the list.
<p>Definition at line <a class="el" href="bundling_2BundleList_8h-source.html#l00330">330</a> of file <a class="el" href="bundling_2BundleList_8h-source.html">bundling/BundleList.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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1BlockingBundleList.html#c14d6077337e48362b390f2ea3f2e095">BlockingBundleList</a> (const std::string &name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1BlockingBundleList.html#ca722942b1031dae4a0c0012938297aa">~BlockingBundleList</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespacedtn.html#87094f3b26b9f1d469e616d311ae57b1">BundleRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1BlockingBundleList.html#e26c8fce019eb0062f0cff1a03f4e2a3">pop_blocking</a> (int timeout=-1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove (and return) the first bundle on the list, blocking (potentially limited by the given timeout) if there are none. <a href="#e26c8fce019eb0062f0cff1a03f4e2a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">oasys::Notifier * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1BlockingBundleList.html#77bf490a649453c36030dc6c8a359fe7">notifier</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the internal notifier. <a href="#77bf490a649453c36030dc6c8a359fe7"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="c14d6077337e48362b390f2ea3f2e095"></a><!-- doxytag: member="dtn::BlockingBundleList::BlockingBundleList" ref="c14d6077337e48362b390f2ea3f2e095" args="(const std::string &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dtn::BlockingBundleList::BlockingBundleList </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="BundleList_8cc-source.html#l00498">498</a> of file <a class="el" href="BundleList_8cc-source.html">BundleList.cc</a>.</p>
<p>References <a class="el" href="bundling_2BundleList_8h-source.html#l00321">dtn::BundleList::notifier_</a>.</p>
</div>
</div><p>
<a class="anchor" name="ca722942b1031dae4a0c0012938297aa"></a><!-- doxytag: member="dtn::BlockingBundleList::~BlockingBundleList" ref="ca722942b1031dae4a0c0012938297aa" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dtn::BlockingBundleList::~BlockingBundleList </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="BundleList_8cc-source.html#l00505">505</a> of file <a class="el" href="BundleList_8cc-source.html">BundleList.cc</a>.</p>
<p>References <a class="el" href="bundling_2BundleList_8h-source.html#l00321">dtn::BundleList::notifier_</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e26c8fce019eb0062f0cff1a03f4e2a3"></a><!-- doxytag: member="dtn::BlockingBundleList::pop_blocking" ref="e26c8fce019eb0062f0cff1a03f4e2a3" args="(int timeout=-1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacedtn.html#87094f3b26b9f1d469e616d311ae57b1">BundleRef</a> dtn::BlockingBundleList::pop_blocking </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>timeout</em> = <code>-1</code> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove (and return) the first bundle on the list, blocking (potentially limited by the given timeout) if there are none.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a reference to the bundle or a reference to NULL if the list is empty. </dd></dl>
<p>Definition at line <a class="el" href="BundleList_8cc-source.html#l00513">513</a> of file <a class="el" href="BundleList_8cc-source.html">BundleList.cc</a>.</p>
<p>References <a class="el" href="SDNV_8cc-source.html#l00044">ASSERT</a>, <a class="el" href="BundleList_8cc-source.html#l00467">dtn::BundleList::empty()</a>, <a class="el" href="bundling_2BundleList_8h-source.html#l00319">dtn::BundleList::lock_</a>, <a class="el" href="bundling_2BundleList_8h-source.html#l00290">dtn::BundleList::name()</a>, <a class="el" href="bundling_2BundleList_8h-source.html#l00321">dtn::BundleList::notifier_</a>, and <a class="el" href="BundleList_8cc-source.html#l00235">dtn::BundleList::pop_front()</a>.</p>
</div>
</div><p>
<a class="anchor" name="77bf490a649453c36030dc6c8a359fe7"></a><!-- doxytag: member="dtn::BlockingBundleList::notifier" ref="77bf490a649453c36030dc6c8a359fe7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">oasys::Notifier* dtn::BlockingBundleList::notifier </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Accessor for the internal notifier.
<p>
<p>Definition at line <a class="el" href="bundling_2BundleList_8h-source.html#l00348">348</a> of file <a class="el" href="bundling_2BundleList_8h-source.html">bundling/BundleList.h</a>.</p>
<p>References <a class="el" href="bundling_2BundleList_8h-source.html#l00321">dtn::BundleList::notifier_</a>.</p>
<p>Referenced by <a class="el" href="APIServer_8cc-source.html#l01620">dtn::APIClient::wait_for_notify()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="bundling_2BundleList_8h-source.html">bundling/BundleList.h</a><li><a class="el" href="BundleList_8cc-source.html">BundleList.cc</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jul 21 14:09:51 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>
