<!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::APIBlockProcessor 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_1APIBlockProcessor.html">APIBlockProcessor</a>
</div>
</div>
<div class="contents">
<h1>dtn::APIBlockProcessor Class Reference</h1><!-- doxytag: class="dtn::APIBlockProcessor" --><!-- doxytag: inherits="dtn::BlockProcessor" --><code>#include <<a class="el" href="APIBlockProcessor_8h-source.html">APIBlockProcessor.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for dtn::APIBlockProcessor:</div>
<div class="dynsection">
<p><center><img src="classdtn_1_1APIBlockProcessor.png" usemap="#dtn::APIBlockProcessor_map" border="0" alt=""></center>
<map name="dtn::APIBlockProcessor_map">
<area href="classdtn_1_1BlockProcessor.html" alt="dtn::BlockProcessor" shape="rect" coords="0,0,144,24">
</map>
</div>
<p>
<a href="classdtn_1_1APIBlockProcessor-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Block processor implementation for any bundle block generated by the API.
<p>Definition at line <a class="el" href="APIBlockProcessor_8h-source.html#l00029">29</a> of file <a class="el" href="APIBlockProcessor_8h-source.html">APIBlockProcessor.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_1APIBlockProcessor.html#b40aac6e3b39add4ac8c7c1ef28250b7">APIBlockProcessor</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#b40aac6e3b39add4ac8c7c1ef28250b7"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1APIBlockProcessor.html#f1f1e31555a6065383178d8f2b009a39">consume</a> (<a class="el" href="classdtn_1_1Bundle.html">Bundle</a> *bundle, <a class="el" href="classdtn_1_1BlockInfo.html">BlockInfo</a> *block, u_char *<a class="el" href="num2sdnv_8c.html#a81cdcc7ff6987bc85c073253e32715f">buf</a>, size_t len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual from <a class="el" href="classdtn_1_1BlockProcessor.html" title="Base class for the protocol handling of bundle blocks, including the core primary...">BlockProcessor</a>. <a href="#f1f1e31555a6065383178d8f2b009a39"></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_1APIBlockProcessor.html#b0b0e9cd6ba6360ecf479a4d0ced218f">generate</a> (const <a class="el" href="classdtn_1_1Bundle.html">Bundle</a> *bundle, <a class="el" href="classdtn_1_1BlockInfoVec.html">BlockInfoVec</a> *xmit_blocks, <a class="el" href="classdtn_1_1BlockInfo.html">BlockInfo</a> *block, const <a class="el" href="namespacedtn.html#6efb37e503f8062c537b022eb755b94e">LinkRef</a> &link, <a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> last)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual from <a class="el" href="classdtn_1_1BlockProcessor.html" title="Base class for the protocol handling of bundle blocks, including the core primary...">BlockProcessor</a>. <a href="#b0b0e9cd6ba6360ecf479a4d0ced218f"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="b40aac6e3b39add4ac8c7c1ef28250b7"></a><!-- doxytag: member="dtn::APIBlockProcessor::APIBlockProcessor" ref="b40aac6e3b39add4ac8c7c1ef28250b7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dtn::APIBlockProcessor::APIBlockProcessor </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
<p>Definition at line <a class="el" href="APIBlockProcessor_8cc-source.html#l00032">32</a> of file <a class="el" href="APIBlockProcessor_8cc-source.html">APIBlockProcessor.cc</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f1f1e31555a6065383178d8f2b009a39"></a><!-- doxytag: member="dtn::APIBlockProcessor::consume" ref="f1f1e31555a6065383178d8f2b009a39" args="(Bundle *bundle, BlockInfo *block, u_char *buf, size_t len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dtn::APIBlockProcessor::consume </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classdtn_1_1Bundle.html">Bundle</a> * </td>
<td class="paramname"> <em>bundle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classdtn_1_1BlockInfo.html">BlockInfo</a> * </td>
<td class="paramname"> <em>block</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u_char * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>len</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Virtual from <a class="el" href="classdtn_1_1BlockProcessor.html" title="Base class for the protocol handling of bundle blocks, including the core primary...">BlockProcessor</a>.
<p>
<p>Reimplemented from <a class="el" href="classdtn_1_1BlockProcessor.html#1f73d119593ef13da9c5ee845fd5ec00">dtn::BlockProcessor</a>.</p>
<p>Definition at line <a class="el" href="APIBlockProcessor_8cc-source.html#l00039">39</a> of file <a class="el" href="APIBlockProcessor_8cc-source.html">APIBlockProcessor.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="b0b0e9cd6ba6360ecf479a4d0ced218f"></a><!-- doxytag: member="dtn::APIBlockProcessor::generate" ref="b0b0e9cd6ba6360ecf479a4d0ced218f" args="(const Bundle *bundle, BlockInfoVec *xmit_blocks, BlockInfo *block, const LinkRef &link, bool last)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dtn::APIBlockProcessor::generate </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classdtn_1_1Bundle.html">Bundle</a> * </td>
<td class="paramname"> <em>bundle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classdtn_1_1BlockInfoVec.html">BlockInfoVec</a> * </td>
<td class="paramname"> <em>xmit_blocks</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classdtn_1_1BlockInfo.html">BlockInfo</a> * </td>
<td class="paramname"> <em>block</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacedtn.html#6efb37e503f8062c537b022eb755b94e">LinkRef</a> & </td>
<td class="paramname"> <em>link</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> </td>
<td class="paramname"> <em>last</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Virtual from <a class="el" href="classdtn_1_1BlockProcessor.html" title="Base class for the protocol handling of bundle blocks, including the core primary...">BlockProcessor</a>.
<p>
<p>Implements <a class="el" href="classdtn_1_1BlockProcessor.html#93079be0f3f307ae9a800106a9518f3e">dtn::BlockProcessor</a>.</p>
<p>Definition at line <a class="el" href="APIBlockProcessor_8cc-source.html#l00054">54</a> of file <a class="el" href="APIBlockProcessor_8cc-source.html">APIBlockProcessor.cc</a>.</p>
<p>References <a class="el" href="SDNV_8cc-source.html#l00044">ASSERT</a>, <a class="el" href="BundleProtocol_8h-source.html#l00199">dtn::BundleProtocol::BLOCK_FLAG_LAST_BLOCK</a>, <a class="el" href="BlockProcessor_8h-source.html#l00034">BP_SUCCESS</a>, <a class="el" href="BlockInfo_8h-source.html#l00075">dtn::BlockInfo::contents()</a>, <a class="el" href="BlockInfo_8h-source.html#l00077">dtn::BlockInfo::data_length()</a>, <a class="el" href="BlockInfo_8h-source.html#l00078">dtn::BlockInfo::data_offset()</a>, <a class="el" href="BlockInfo_8cc-source.html#l00118">dtn::BlockInfo::flags()</a>, <a class="el" href="BlockInfo_8h-source.html#l00079">dtn::BlockInfo::full_length()</a>, <a class="el" href="BlockProcessor_8cc-source.html#l00206">dtn::BlockProcessor::generate_preamble()</a>, <a class="el" href="BlockInfo_8h-source.html#l00072">dtn::BlockInfo::owner()</a>, <a class="el" href="BlockInfo_8h-source.html#l00073">dtn::BlockInfo::source()</a>, <a class="el" href="BlockInfo_8cc-source.html#l00094">dtn::BlockInfo::type()</a>, and <a class="el" href="BlockInfo_8h-source.html#l00094">dtn::BlockInfo::writable_contents()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="APIBlockProcessor_8h-source.html">APIBlockProcessor.h</a><li><a class="el" href="APIBlockProcessor_8cc-source.html">APIBlockProcessor.cc</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jul 21 14:09:50 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>
