<!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: PrimaryBlockProcessor.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 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 List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<h1>PrimaryBlockProcessor.h</h1><a href="PrimaryBlockProcessor_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 Intel 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
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef _PRIMARY_BLOCK_PROCESSOR_H_</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _PRIMARY_BLOCK_PROCESSOR_H_</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include "<a class="code" href="BlockProcessor_8h.html">BlockProcessor.h</a>"</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="keyword">namespace </span>dtn {
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="keyword">class </span>DictionaryVector;
<a name="l00025"></a>00025 <span class="keyword">class </span>EndpointID;
<a name="l00026"></a>00026
<a name="l00030"></a><a class="code" href="classdtn_1_1PrimaryBlockProcessor.html">00030</a> <span class="keyword">class </span><a class="code" href="classdtn_1_1PrimaryBlockProcessor.html" title="Block processor implementation for the primary bundle block.">PrimaryBlockProcessor</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="l00031"></a>00031 <span class="keyword">public</span>:
<a name="l00033"></a>00033 <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#937b663bfe5ae27f15217c5c80abae01" title="Constructor.">PrimaryBlockProcessor</a>();
<a name="l00034"></a>00034
<a name="l00036"></a>00036 <span class="keywordtype">int</span> <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#6e5c41fd30e22ae3d0e1f9f4ce3dec22" 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="l00037"></a>00037 <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="l00038"></a>00038 u_char* <a class="code" href="num2sdnv_8c.html#a81cdcc7ff6987bc85c073253e32715f">buf</a>,
<a name="l00039"></a>00039 <span class="keywordtype">size_t</span> <a class="code" href="num2sdnv_8c.html#fed088663f8704004425cdae2120b9b3">len</a>);
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="keywordtype">bool</span> <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#2fbc1715b03d51dddd4517414335502c" 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="l00042"></a>00042 <a class="code" href="classdtn_1_1BlockInfoVec.html" title="Class for a vector of BlockInfo structures.">BlockInfoVec</a>* block_list,
<a name="l00043"></a>00043 <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="l00044"></a>00044 <a class="code" href="classdtn_1_1BundleProtocol.html#37b000d94172c06970bb8af32889f917" title="Bundle Status Report &quot;Reason Code&quot; flags.">status_report_reason_t</a>* reception_reason,
<a name="l00045"></a>00045 <a class="code" href="classdtn_1_1BundleProtocol.html#37b000d94172c06970bb8af32889f917" title="Bundle Status Report &quot;Reason Code&quot; flags.">status_report_reason_t</a>* deletion_reason);
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="keywordtype">int</span> <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#a3a1005ed5dedac560fa0e694504fa24" 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="l00048"></a>00048 <a class="code" href="classdtn_1_1BlockInfoVec.html" title="Class for a vector of BlockInfo structures.">BlockInfoVec</a>* xmit_blocks,
<a name="l00049"></a>00049 <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="l00050"></a>00050 <span class="keyword">const</span> <a class="code" href="namespacedtn.html#6efb37e503f8062c537b022eb755b94e" title="Typedef for a reference on a link.">LinkRef</a>& link,
<a name="l00051"></a>00051 <a class="code" href="classdtn_1_1BlockInfo.html#3d0bc8cd207912ac5406fde3fc2c8d1c" title="List owner indicator (not transmitted).">list_owner_t</a> list);
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="keywordtype">int</span> <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#75c9dac1627305cebd6401dd1e86e95a" 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="l00054"></a>00054 <a class="code" href="classdtn_1_1BlockInfoVec.html" title="Class for a vector of BlockInfo structures.">BlockInfoVec</a>* xmit_blocks,
<a name="l00055"></a>00055 <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="l00056"></a>00056 <span class="keyword">const</span> <a class="code" href="namespacedtn.html#6efb37e503f8062c537b022eb755b94e" title="Typedef for a reference on a link.">LinkRef</a>& link,
<a name="l00057"></a>00057 <span class="keywordtype">bool</span> last);
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#541fb8e13968042f46b8d6e699e81941" title="Virtual from BlockProcessor.">generate_primary</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="l00060"></a>00060 <a class="code" href="classdtn_1_1BlockInfoVec.html" title="Class for a vector of BlockInfo structures.">BlockInfoVec</a>* xmit_blocks,
<a name="l00061"></a>00061 <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="l00063"></a>00063
<a name="l00064"></a>00064 <span class="keyword">protected</span>:
<a name="l00069"></a><a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#8eaf1adb137e84715d8d1c2588bf1590">00069</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00070"></a><a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#8eaf1adb137e84715d8d1c2588bf1590239be97dedd4104bc85d8e423b5ac33f">00070</a> <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#8eaf1adb137e84715d8d1c2588bf1590239be97dedd4104bc85d8e423b5ac33f">BUNDLE_IS_FRAGMENT</a> = 1 << 0,
<a name="l00071"></a><a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#8eaf1adb137e84715d8d1c2588bf15901e598df2393cb90b3cd47c7bb842e142">00071</a> <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#8eaf1adb137e84715d8d1c2588bf15901e598df2393cb90b3cd47c7bb842e142">BUNDLE_IS_ADMIN</a> = 1 << 1,
<a name="l00072"></a><a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#8eaf1adb137e84715d8d1c2588bf159069b81b44a73c2e669e8af7beff6cf8fb">00072</a> <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#8eaf1adb137e84715d8d1c2588bf159069b81b44a73c2e669e8af7beff6cf8fb">BUNDLE_DO_NOT_FRAGMENT</a> = 1 << 2,
<a name="l00073"></a><a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#8eaf1adb137e84715d8d1c2588bf159059c3ae36ce59ffb3688546c97898fcb4">00073</a> <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#8eaf1adb137e84715d8d1c2588bf159059c3ae36ce59ffb3688546c97898fcb4">BUNDLE_CUSTODY_XFER_REQUESTED</a> = 1 << 3,
<a name="l00074"></a><a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#8eaf1adb137e84715d8d1c2588bf1590933b3d5cd0c8407e97a5717cdfe2845f">00074</a> <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#8eaf1adb137e84715d8d1c2588bf1590933b3d5cd0c8407e97a5717cdfe2845f">BUNDLE_SINGLETON_DESTINATION</a> = 1 << 4,
<a name="l00075"></a><a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#8eaf1adb137e84715d8d1c2588bf15901af11a25f1a3143e0fafb8c322ab5ade">00075</a> <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#8eaf1adb137e84715d8d1c2588bf15901af11a25f1a3143e0fafb8c322ab5ade">BUNDLE_ACK_BY_APP</a> = 1 << 5,
<a name="l00076"></a><a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#8eaf1adb137e84715d8d1c2588bf159001c667e5deeeaefdc07b953c1e9c995a">00076</a> <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#8eaf1adb137e84715d8d1c2588bf159001c667e5deeeaefdc07b953c1e9c995a">BUNDLE_UNUSED</a> = 1 << 6
<a name="l00077"></a>00077 } <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#8eaf1adb137e84715d8d1c2588bf1590" title="Values for bundle processing flags that appear in the primary block.">bundle_processing_flag_t</a>;
<a name="l00078"></a>00078
<a name="l00083"></a><a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html">00083</a> <span class="keyword">struct </span><a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html" title="The remainder of the fixed-length part of the primary bundle block that immediately...">PrimaryBlock</a> {
<a name="l00084"></a><a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#61f3cedfb63a80ac5a714f793dadf001">00084</a> u_int8_t <a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#61f3cedfb63a80ac5a714f793dadf001">version</a>;
<a name="l00085"></a><a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#27369d5c0c8ff5838886dd16265544e0">00085</a> u_int64_t <a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#27369d5c0c8ff5838886dd16265544e0">processing_flags</a>;
<a name="l00086"></a><a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#7df49882074054a2a507ce1594d6fb62">00086</a> u_int64_t <a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#7df49882074054a2a507ce1594d6fb62">block_length</a>;
<a name="l00087"></a><a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#e000a7721dc9ec46e1c46ec338ac142b">00087</a> u_int64_t <a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#e000a7721dc9ec46e1c46ec338ac142b">dest_scheme_offset</a>;
<a name="l00088"></a><a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#56b10b8316036e4666876b204c395f3d">00088</a> u_int64_t <a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#56b10b8316036e4666876b204c395f3d">dest_ssp_offset</a>;
<a name="l00089"></a><a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#9c3102b6d048f856d76e9756d47529e0">00089</a> u_int64_t <a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#9c3102b6d048f856d76e9756d47529e0">source_scheme_offset</a>;
<a name="l00090"></a><a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#999e6bd31377676bc73705fd507b7dc9">00090</a> u_int64_t <a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#999e6bd31377676bc73705fd507b7dc9">source_ssp_offset</a>;
<a name="l00091"></a><a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#e717b3248b2fef4ec3b36289374504cd">00091</a> u_int64_t <a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#e717b3248b2fef4ec3b36289374504cd">replyto_scheme_offset</a>;
<a name="l00092"></a><a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#3baf17b33d2833a32b49e99274129c7a">00092</a> u_int64_t <a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#3baf17b33d2833a32b49e99274129c7a">replyto_ssp_offset</a>;
<a name="l00093"></a><a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#8b5daa5014dc86c729904d1f64dcb7b9">00093</a> u_int64_t <a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#8b5daa5014dc86c729904d1f64dcb7b9">custodian_scheme_offset</a>;
<a name="l00094"></a><a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#3620e1a0301accfd0f67f1e7058c043f">00094</a> u_int64_t <a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#3620e1a0301accfd0f67f1e7058c043f">custodian_ssp_offset</a>;
<a name="l00095"></a><a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#8334d024718d794eff9ac9fc8ccaa10f">00095</a> u_int64_t <a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#8334d024718d794eff9ac9fc8ccaa10f">creation_time</a>;
<a name="l00096"></a><a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#04939e86c10b9c03fd5827655dd5200c">00096</a> u_int64_t <a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#04939e86c10b9c03fd5827655dd5200c">creation_sequence</a>;
<a name="l00097"></a><a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#94a6e34e16c95daeadbebbce04e8d1ea">00097</a> u_int64_t <a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#94a6e34e16c95daeadbebbce04e8d1ea">lifetime</a>;
<a name="l00098"></a><a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#0048e045a498b1ae922092c52c0cada3">00098</a> u_int64_t <a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html#0048e045a498b1ae922092c52c0cada3">dictionary_length</a>;
<a name="l00099"></a>00099 };
<a name="l00100"></a>00100
<a name="l00101"></a>00101
<a name="l00104"></a><a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#226a2c8d06ec75da24a71e730275802b">00104</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classdtn_1_1BundleProtocol.html" title="Centralized class used to convert a Bundle to / from the bundle protocol specification...">BundleProtocol</a>;
<a name="l00105"></a>00105
<a name="l00106"></a>00106 <span class="keyword">static</span> <span class="keywordtype">size_t</span> <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#49e5f6762a4b65450995e15e3d377864">get_primary_len</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="l00107"></a>00107 <a class="code" href="classdtn_1_1Dictionary.html" title="Simple data structure to handle a dictionary data structure, as specified by the...">Dictionary</a>* dict,
<a name="l00108"></a>00108 <a class="code" href="structdtn_1_1PrimaryBlockProcessor_1_1PrimaryBlock.html" title="The remainder of the fixed-length part of the primary bundle block that immediately...">PrimaryBlock</a>* primary);
<a name="l00109"></a>00109
<a name="l00110"></a>00110 <span class="keyword">static</span> u_int64_t <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#6af9dae8b00ea10b837529c711dce499">format_bundle_flags</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="l00111"></a>00111 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#50097e7812b01ee86d75fa3bf537c4ec">parse_bundle_flags</a>(<a class="code" href="classdtn_1_1Bundle.html" title="The internal representation of a bundle.">Bundle</a>* bundle, u_int64_t flags);
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="keyword">static</span> u_int64_t <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#801e0dbe517b21953154a8f6df95457d">format_cos_flags</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="l00114"></a>00114 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#77f98160013cfeaeddce5bfab92033ad">parse_cos_flags</a>(<a class="code" href="classdtn_1_1Bundle.html" title="The internal representation of a bundle.">Bundle</a>* bundle, u_int64_t cos_flags);
<a name="l00115"></a>00115
<a name="l00116"></a>00116 <span class="keyword">static</span> u_int64_t <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#a987548dc642eca97ee24a867185987c">format_srr_flags</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="l00117"></a>00117 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1PrimaryBlockProcessor.html#894369d093911b3b00adaf38c1953e44">parse_srr_flags</a>(<a class="code" href="classdtn_1_1Bundle.html" title="The internal representation of a bundle.">Bundle</a>* bundle, u_int64_t srr_flags);
<a name="l00119"></a>00119 };
<a name="l00120"></a>00120
<a name="l00121"></a>00121 } <span class="comment">// namespace dtn</span>
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <span class="preprocessor">#endif </span><span class="comment">/* _PRIMARY_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
<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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
29c369053a983cc5d8c880dc6e0a2237
>
files
>
476
