Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 29c369053a983cc5d8c880dc6e0a2237 > files > 404

libdtn-devel-2.6.0-2mdv2009.1.i586.rpm

<!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: MetadataBlockProcessor.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
    </ul>
  </div>
<h1>MetadataBlockProcessor.h</h1><a href="MetadataBlockProcessor_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> *    Copyright 2006-2007 The MITRE Corporation</span>
<a name="l00003"></a>00003 <span class="comment"> * </span>
<a name="l00004"></a>00004 <span class="comment"> *    Licensed under the Apache License, Version 2.0 (the "License");</span>
<a name="l00005"></a>00005 <span class="comment"> *    you may not use this file except in compliance with the License.</span>
<a name="l00006"></a>00006 <span class="comment"> *    You may obtain a copy of the License at</span>
<a name="l00007"></a>00007 <span class="comment"> * </span>
<a name="l00008"></a>00008 <span class="comment"> *        http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00009"></a>00009 <span class="comment"> * </span>
<a name="l00010"></a>00010 <span class="comment"> *    Unless required by applicable law or agreed to in writing, software</span>
<a name="l00011"></a>00011 <span class="comment"> *    distributed under the License is distributed on an "AS IS" BASIS,</span>
<a name="l00012"></a>00012 <span class="comment"> *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00013"></a>00013 <span class="comment"> *    See the License for the specific language governing permissions and</span>
<a name="l00014"></a>00014 <span class="comment"> *    limitations under the License.</span>
<a name="l00015"></a>00015 <span class="comment"> *</span>
<a name="l00016"></a>00016 <span class="comment"> *    The US Government will not be charged any license fee and/or royalties</span>
<a name="l00017"></a>00017 <span class="comment"> *    related to this software. Neither name of The MITRE Corporation; nor the</span>
<a name="l00018"></a>00018 <span class="comment"> *    names of its contributors may be used to endorse or promote products</span>
<a name="l00019"></a>00019 <span class="comment"> *    derived from this software without specific prior written permission.</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021 
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef _METADATA_BLOCK_PROCESSOR_H_</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define _METADATA_BLOCK_PROCESSOR_H_</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="BlockProcessor_8h.html">BlockProcessor.h</a>"</span>
<a name="l00026"></a>00026 
<a name="l00027"></a>00027 <span class="keyword">namespace </span>dtn {
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="keyword">class </span>MetadataBlock;
<a name="l00030"></a>00030 
<a name="l00034"></a><a class="code" href="classdtn_1_1MetadataBlockProcessor.html">00034</a> <span class="keyword">class </span><a class="code" href="classdtn_1_1MetadataBlockProcessor.html" title="Block processor implementation for the metadata extension block.">MetadataBlockProcessor</a> : <span class="keyword">public</span> <a class="code" href="classdtn_1_1BlockProcessor.html" title="Base class for the protocol handling of bundle blocks, including the core primary...">BlockProcessor</a> {
<a name="l00035"></a>00035 <span class="keyword">public</span>:
<a name="l00036"></a>00036 
<a name="l00038"></a>00038     <a class="code" href="classdtn_1_1MetadataBlockProcessor.html#22ff548d14306f6a42313b241bac5882" title="Constructor.">MetadataBlockProcessor</a>();
<a name="l00039"></a>00039 
<a name="l00041"></a>00041     <span class="keywordtype">int</span>  <a class="code" href="classdtn_1_1MetadataBlockProcessor.html#92e1b37e43c0bbd92f328d3ede10b78e" title="Virtual from BlockProcessor.">consume</a>(<a class="code" href="classdtn_1_1Bundle.html" title="The internal representation of a bundle.">Bundle</a>*    bundle,
<a name="l00042"></a>00042                  <a class="code" href="classdtn_1_1BlockInfo.html" title="Class used to store unparsed bundle blocks and associated metadata about them.">BlockInfo</a>* block,
<a name="l00043"></a>00043                  u_char*    <a class="code" href="num2sdnv_8c.html#a81cdcc7ff6987bc85c073253e32715f">buf</a>,
<a name="l00044"></a>00044                  <span class="keywordtype">size_t</span>     <a class="code" href="num2sdnv_8c.html#fed088663f8704004425cdae2120b9b3">len</a>);
<a name="l00045"></a>00045 
<a name="l00046"></a>00046     <span class="keywordtype">bool</span> <a class="code" href="classdtn_1_1MetadataBlockProcessor.html#679fdea0736757a843cc9075d22ff515" title="Virtual from BlockProcessor.">validate</a>(<span class="keyword">const</span> <a class="code" href="classdtn_1_1Bundle.html" title="The internal representation of a bundle.">Bundle</a>*           bundle,
<a name="l00047"></a>00047                   <a class="code" href="classdtn_1_1BlockInfoVec.html" title="Class for a vector of BlockInfo structures.">BlockInfoVec</a>*           block_list,
<a name="l00048"></a>00048                   <a class="code" href="classdtn_1_1BlockInfo.html" title="Class used to store unparsed bundle blocks and associated metadata about them.">BlockInfo</a>*              block,
<a name="l00049"></a>00049                   <a class="code" href="classdtn_1_1BundleProtocol.html#37b000d94172c06970bb8af32889f917" title="Bundle Status Report &amp;quot;Reason Code&amp;quot; flags.">status_report_reason_t</a>* reception_reason,
<a name="l00050"></a>00050                   <a class="code" href="classdtn_1_1BundleProtocol.html#37b000d94172c06970bb8af32889f917" title="Bundle Status Report &amp;quot;Reason Code&amp;quot; flags.">status_report_reason_t</a>* deletion_reason);
<a name="l00051"></a>00051 
<a name="l00052"></a>00052     <span class="keywordtype">int</span> <a class="code" href="classdtn_1_1MetadataBlockProcessor.html#63f5d0f32404210cd68b6601d7abc748" title="Virtual from BlockProcessor.">prepare</a>(<span class="keyword">const</span> <a class="code" href="classdtn_1_1Bundle.html" title="The internal representation of a bundle.">Bundle</a>*     bundle,
<a name="l00053"></a>00053                  <a class="code" href="classdtn_1_1BlockInfoVec.html" title="Class for a vector of BlockInfo structures.">BlockInfoVec</a>*    xmit_blocks,
<a name="l00054"></a>00054                  <span class="keyword">const</span> <a class="code" href="classdtn_1_1BlockInfo.html" title="Class used to store unparsed bundle blocks and associated metadata about them.">BlockInfo</a>* source,
<a name="l00055"></a>00055                  <span class="keyword">const</span> <a class="code" href="namespacedtn.html#6efb37e503f8062c537b022eb755b94e" title="Typedef for a reference on a link.">LinkRef</a>&amp;   link,
<a name="l00056"></a>00056                  <a class="code" href="classdtn_1_1BlockInfo.html#3d0bc8cd207912ac5406fde3fc2c8d1c" title="List owner indicator (not transmitted).">list_owner_t</a>     list);
<a name="l00057"></a>00057 
<a name="l00058"></a>00058     <span class="keywordtype">int</span> <a class="code" href="classdtn_1_1MetadataBlockProcessor.html#3bb5baa33e5a4ab2883ce70907d9934c" title="Virtual from BlockProcessor.">generate</a>(<span class="keyword">const</span> <a class="code" href="classdtn_1_1Bundle.html" title="The internal representation of a bundle.">Bundle</a>*  bundle,
<a name="l00059"></a>00059                   <a class="code" href="classdtn_1_1BlockInfoVec.html" title="Class for a vector of BlockInfo structures.">BlockInfoVec</a>*  xmit_blocks,
<a name="l00060"></a>00060                   <a class="code" href="classdtn_1_1BlockInfo.html" title="Class used to store unparsed bundle blocks and associated metadata about them.">BlockInfo</a>*     block,
<a name="l00061"></a>00061                   <span class="keyword">const</span> <a class="code" href="namespacedtn.html#6efb37e503f8062c537b022eb755b94e" title="Typedef for a reference on a link.">LinkRef</a>&amp; link,
<a name="l00062"></a>00062                   <span class="keywordtype">bool</span>           last);
<a name="l00064"></a>00064 
<a name="l00069"></a>00069     <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1MetadataBlockProcessor.html#34c1cf9074a51a3f0524e7d4d1ca5ea7" title="Determines the generated metadata (not received metadata, which is handled by the...">prepare_generated_metadata</a>(<a class="code" href="classdtn_1_1Bundle.html" title="The internal representation of a bundle.">Bundle</a>*        bundle,
<a name="l00070"></a>00070                                     <a class="code" href="classdtn_1_1BlockInfoVec.html" title="Class for a vector of BlockInfo structures.">BlockInfoVec</a>*  blocks,
<a name="l00071"></a>00071                                     <span class="keyword">const</span> <a class="code" href="namespacedtn.html#6efb37e503f8062c537b022eb755b94e" title="Typedef for a reference on a link.">LinkRef</a>&amp; link);
<a name="l00072"></a>00072 
<a name="l00076"></a>00076     <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1MetadataBlockProcessor.html#7ad78787a5ed3be4d082c529aaa8fa0a" title="Deletes bundle state maintained for generated metadata.">delete_generated_metadata</a>(<a class="code" href="classdtn_1_1Bundle.html" title="The internal representation of a bundle.">Bundle</a>* bundle, <span class="keyword">const</span> <a class="code" href="namespacedtn.html#6efb37e503f8062c537b022eb755b94e" title="Typedef for a reference on a link.">LinkRef</a>&amp; link);
<a name="l00077"></a>00077 
<a name="l00078"></a>00078 <span class="keyword">private</span>:
<a name="l00079"></a>00079 
<a name="l00085"></a>00085     <span class="keywordtype">bool</span> <a class="code" href="classdtn_1_1MetadataBlockProcessor.html#5ca13fab01ec05d27f372dd0b76fd7d1" title="Parses a metadata extension block.">parse_metadata</a>(<a class="code" href="classdtn_1_1Bundle.html" title="The internal representation of a bundle.">Bundle</a>* bundle, <a class="code" href="classdtn_1_1BlockInfo.html" title="Class used to store unparsed bundle blocks and associated metadata about them.">BlockInfo</a>* block);
<a name="l00086"></a>00086 
<a name="l00094"></a>00094     <span class="keywordtype">bool</span> <a class="code" href="classdtn_1_1MetadataBlockProcessor.html#63b2d0b1bb0f10657bf8b2a57276e73b" title="Handles a metadata extension block processing error based on the block preamble flags...">handle_error</a>(<span class="keyword">const</span> <a class="code" href="classdtn_1_1BlockInfo.html" title="Class used to store unparsed bundle blocks and associated metadata about them.">BlockInfo</a>*        block,
<a name="l00095"></a>00095                       <a class="code" href="classdtn_1_1BundleProtocol.html#37b000d94172c06970bb8af32889f917" title="Bundle Status Report &amp;quot;Reason Code&amp;quot; flags.">status_report_reason_t</a>* reception_reason,
<a name="l00096"></a>00096                       <a class="code" href="classdtn_1_1BundleProtocol.html#37b000d94172c06970bb8af32889f917" title="Bundle Status Report &amp;quot;Reason Code&amp;quot; flags.">status_report_reason_t</a>* deletion_reason);
<a name="l00097"></a>00097 };
<a name="l00098"></a>00098 
<a name="l00099"></a>00099 } <span class="comment">// namespace dtn</span>
<a name="l00100"></a>00100 
<a name="l00101"></a>00101 <span class="preprocessor">#endif </span><span class="comment">/* _METADATA_BLOCK_PROCESSOR_H_ */</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jan 30 09:26:57 2009 for DTN Reference Implementation by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>