<!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::FileConvergenceLayer::Scanner 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_1FileConvergenceLayer.html">FileConvergenceLayer</a>::<a class="el" href="classdtn_1_1FileConvergenceLayer_1_1Scanner.html">Scanner</a> </div> </div> <div class="contents"> <h1>dtn::FileConvergenceLayer::Scanner Class Reference</h1><!-- doxytag: class="dtn::FileConvergenceLayer::Scanner" --><!-- doxytag: inherits="dtn::CLInfo" --><code>#include <<a class="el" href="FileConvergenceLayer_8h-source.html">FileConvergenceLayer.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for dtn::FileConvergenceLayer::Scanner:</div> <div class="dynsection"> <p><center><img src="classdtn_1_1FileConvergenceLayer_1_1Scanner.png" usemap="#dtn::FileConvergenceLayer::Scanner_map" border="0" alt=""></center> <map name="dtn::FileConvergenceLayer::Scanner_map"> <area href="classdtn_1_1CLInfo.html" alt="dtn::CLInfo" shape="rect" coords="0,0,220,24"> </map> </div> <p> <a href="classdtn_1_1FileConvergenceLayer_1_1Scanner-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> Helper class (and thread) that periodically scans a directory for new bundle files. <p>Definition at line <a class="el" href="FileConvergenceLayer_8h-source.html#l00072">72</a> of file <a class="el" href="FileConvergenceLayer_8h-source.html">FileConvergenceLayer.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_1FileConvergenceLayer_1_1Scanner.html#52e018fa6adff065a777de4a3927ea15">Scanner</a> (int secs_per_scan, const std::string &dir)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#52e018fa6adff065a777de4a3927ea15"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1FileConvergenceLayer_1_1Scanner.html#45b943fa295afcd4412db5552a9b91a7">stop</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the flag to ask it to stop next loop. <a href="#45b943fa295afcd4412db5552a9b91a7"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1FileConvergenceLayer_1_1Scanner.html#d9d80c9b7894db3c7d005a192211a88d">serialize</a> (oasys::SerializableObject *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual from SerializableObject. <a href="#d9d80c9b7894db3c7d005a192211a88d"></a><br></td></tr> <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1FileConvergenceLayer_1_1Scanner.html#e98e1aa7487d913cd161fe4c47413d1b">run</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Main thread function. <a href="#e98e1aa7487d913cd161fe4c47413d1b"></a><br></td></tr> <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1FileConvergenceLayer_1_1Scanner.html#090e178d536f5c9dfda8567e5d2ead64">secs_per_scan_</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">scan interval <a href="#090e178d536f5c9dfda8567e5d2ead64"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1FileConvergenceLayer_1_1Scanner.html#e49505a7014d9056bce8059df80bc289">dir_</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">directory to scan for bundles. <a href="#e49505a7014d9056bce8059df80bc289"></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_1FileConvergenceLayer_1_1Scanner.html#7b62a2ce202ea480977c36a6f01e5d2a">run_</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">keep running? <a href="#7b62a2ce202ea480977c36a6f01e5d2a"></a><br></td></tr> </table> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="52e018fa6adff065a777de4a3927ea15"></a><!-- doxytag: member="dtn::FileConvergenceLayer::Scanner::Scanner" ref="52e018fa6adff065a777de4a3927ea15" args="(int secs_per_scan, const std::string &dir)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">dtn::FileConvergenceLayer::Scanner::Scanner </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>secs_per_scan</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>dir</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p> Constructor. <p> <p>Definition at line <a class="el" href="FileConvergenceLayer_8cc-source.html#l00295">295</a> of file <a class="el" href="FileConvergenceLayer_8cc-source.html">FileConvergenceLayer.cc</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="45b943fa295afcd4412db5552a9b91a7"></a><!-- doxytag: member="dtn::FileConvergenceLayer::Scanner::stop" ref="45b943fa295afcd4412db5552a9b91a7" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void dtn::FileConvergenceLayer::Scanner::stop </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Set the flag to ask it to stop next loop. <p> <p>Definition at line <a class="el" href="FileConvergenceLayer_8cc-source.html#l00441">441</a> of file <a class="el" href="FileConvergenceLayer_8cc-source.html">FileConvergenceLayer.cc</a>.</p> <p>References <a class="el" href="FileConvergenceLayer_8h-source.html#l00097">run_</a>.</p> <p>Referenced by <a class="el" href="FileConvergenceLayer_8cc-source.html#l00156">dtn::FileConvergenceLayer::interface_down()</a>.</p> </div> </div><p> <a class="anchor" name="d9d80c9b7894db3c7d005a192211a88d"></a><!-- doxytag: member="dtn::FileConvergenceLayer::Scanner::serialize" ref="d9d80c9b7894db3c7d005a192211a88d" args="(oasys::SerializableObject *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void dtn::FileConvergenceLayer::Scanner::serialize </td> <td>(</td> <td class="paramtype">oasys::SerializableObject * </td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Virtual from SerializableObject. <p> <p>Definition at line <a class="el" href="FileConvergenceLayer_8h-source.html#l00087">87</a> of file <a class="el" href="FileConvergenceLayer_8h-source.html">FileConvergenceLayer.h</a>.</p> </div> </div><p> <a class="anchor" name="e98e1aa7487d913cd161fe4c47413d1b"></a><!-- doxytag: member="dtn::FileConvergenceLayer::Scanner::run" ref="e98e1aa7487d913cd161fe4c47413d1b" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void dtn::FileConvergenceLayer::Scanner::run </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Main thread function. <p> <p>Definition at line <a class="el" href="FileConvergenceLayer_8cc-source.html#l00311">311</a> of file <a class="el" href="FileConvergenceLayer_8cc-source.html">FileConvergenceLayer.cc</a>.</p> </div> </div><p> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="090e178d536f5c9dfda8567e5d2ead64"></a><!-- doxytag: member="dtn::FileConvergenceLayer::Scanner::secs_per_scan_" ref="090e178d536f5c9dfda8567e5d2ead64" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="classdtn_1_1FileConvergenceLayer_1_1Scanner.html#090e178d536f5c9dfda8567e5d2ead64">dtn::FileConvergenceLayer::Scanner::secs_per_scan_</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> scan interval <p> <p>Definition at line <a class="el" href="FileConvergenceLayer_8h-source.html#l00095">95</a> of file <a class="el" href="FileConvergenceLayer_8h-source.html">FileConvergenceLayer.h</a>.</p> </div> </div><p> <a class="anchor" name="e49505a7014d9056bce8059df80bc289"></a><!-- doxytag: member="dtn::FileConvergenceLayer::Scanner::dir_" ref="e49505a7014d9056bce8059df80bc289" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string <a class="el" href="classdtn_1_1FileConvergenceLayer_1_1Scanner.html#e49505a7014d9056bce8059df80bc289">dtn::FileConvergenceLayer::Scanner::dir_</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> directory to scan for bundles. <p> <p>Definition at line <a class="el" href="FileConvergenceLayer_8h-source.html#l00096">96</a> of file <a class="el" href="FileConvergenceLayer_8h-source.html">FileConvergenceLayer.h</a>.</p> </div> </div><p> <a class="anchor" name="7b62a2ce202ea480977c36a6f01e5d2a"></a><!-- doxytag: member="dtn::FileConvergenceLayer::Scanner::run_" ref="7b62a2ce202ea480977c36a6f01e5d2a" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> <a class="el" href="classdtn_1_1FileConvergenceLayer_1_1Scanner.html#7b62a2ce202ea480977c36a6f01e5d2a">dtn::FileConvergenceLayer::Scanner::run_</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> keep running? <p> <p>Definition at line <a class="el" href="FileConvergenceLayer_8h-source.html#l00097">97</a> of file <a class="el" href="FileConvergenceLayer_8h-source.html">FileConvergenceLayer.h</a>.</p> <p>Referenced by <a class="el" href="FileConvergenceLayer_8cc-source.html#l00441">stop()</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="FileConvergenceLayer_8h-source.html">FileConvergenceLayer.h</a><li><a class="el" href="FileConvergenceLayer_8cc-source.html">FileConvergenceLayer.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>