summaryrefslogtreecommitdiff
path: root/doc/html/packet_8h-source.html
diff options
context:
space:
mode:
authorErwin Nindl <nine@wirdorange.org>2007-10-07 22:07:03 +0000
committerErwin Nindl <nine@wirdorange.org>2007-10-07 22:07:03 +0000
commit7763f07327f3abce839a690df46ced3bfd1d3d09 (patch)
treec80abe2cf8e137edba89cad9f14f63048275cee1 /doc/html/packet_8h-source.html
parentadded doxygen, and doxygen makefile target (diff)
added doxygen generatet documentation
Diffstat (limited to 'doc/html/packet_8h-source.html')
-rw-r--r--doc/html/packet_8h-source.html100
1 files changed, 100 insertions, 0 deletions
diff --git a/doc/html/packet_8h-source.html b/doc/html/packet_8h-source.html
new file mode 100644
index 0000000..cc3f8ec
--- /dev/null
+++ b/doc/html/packet_8h-source.html
@@ -0,0 +1,100 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>anytun: packet.h Source File</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.1 -->
+<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 id="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>packet.h</h1><a href="packet_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"> * anytun</span>
+<a name="l00003"></a>00003 <span class="comment"> *</span>
+<a name="l00004"></a>00004 <span class="comment"> * The secure anycast tunneling protocol (satp) defines a protocol used</span>
+<a name="l00005"></a>00005 <span class="comment"> * for communication between any combination of unicast and anycast</span>
+<a name="l00006"></a>00006 <span class="comment"> * tunnel endpoints. It has less protocol overhead than IPSec in Tunnel</span>
+<a name="l00007"></a>00007 <span class="comment"> * mode and allows tunneling of every ETHER TYPE protocol (e.g.</span>
+<a name="l00008"></a>00008 <span class="comment"> * ethernet, ip, arp ...). satp directly includes cryptography and</span>
+<a name="l00009"></a>00009 <span class="comment"> * message authentication based on the methodes used by SRTP. It is</span>
+<a name="l00010"></a>00010 <span class="comment"> * intended to deliver a generic, scaleable and secure solution for</span>
+<a name="l00011"></a>00011 <span class="comment"> * tunneling and relaying of packets of any protocol.</span>
+<a name="l00012"></a>00012 <span class="comment"> *</span>
+<a name="l00013"></a>00013 <span class="comment"> *</span>
+<a name="l00014"></a>00014 <span class="comment"> * Copyright (C) 2007 anytun.org &lt;satp@wirdorange.org&gt;</span>
+<a name="l00015"></a>00015 <span class="comment"> *</span>
+<a name="l00016"></a>00016 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
+<a name="l00017"></a>00017 <span class="comment"> * it under the terms of the GNU General Public License version 2</span>
+<a name="l00018"></a>00018 <span class="comment"> * as published by the Free Software Foundation.</span>
+<a name="l00019"></a>00019 <span class="comment"> *</span>
+<a name="l00020"></a>00020 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
+<a name="l00021"></a>00021 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<a name="l00022"></a>00022 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
+<a name="l00023"></a>00023 <span class="comment"> * GNU General Public License for more details.</span>
+<a name="l00024"></a>00024 <span class="comment"> *</span>
+<a name="l00025"></a>00025 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
+<a name="l00026"></a>00026 <span class="comment"> * along with this program (see the file COPYING included with this</span>
+<a name="l00027"></a>00027 <span class="comment"> * distribution); if not, write to the Free Software Foundation, Inc.,</span>
+<a name="l00028"></a>00028 <span class="comment"> * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
+<a name="l00029"></a>00029 <span class="comment"> */</span>
+<a name="l00030"></a>00030
+<a name="l00031"></a>00031 <span class="preprocessor">#ifndef _PACKET_H_</span>
+<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#define _PACKET_H_</span>
+<a name="l00033"></a>00033 <span class="preprocessor"></span>
+<a name="l00034"></a>00034 <span class="preprocessor">#include "<a class="code" href="datatypes_8h.html">datatypes.h</a>"</span>
+<a name="l00035"></a>00035 <span class="preprocessor">#include "<a class="code" href="buffer_8h.html">buffer.h</a>"</span>
+<a name="l00036"></a>00036
+<a name="l00037"></a><a class="code" href="classPacket.html">00037</a> <span class="keyword">class </span><a class="code" href="classPacket.html">Packet</a> : <span class="keyword">public</span> <a class="code" href="classBuffer.html">Buffer</a>
+<a name="l00038"></a>00038 {
+<a name="l00039"></a>00039 <span class="keyword">public</span>:
+<a name="l00040"></a>00040 <a class="code" href="classPacket.html#abcfb963c0d5bc0fa554668f92989622">Packet</a>();
+<a name="l00041"></a>00041 <a class="code" href="classPacket.html#abcfb963c0d5bc0fa554668f92989622">Packet</a>(<a class="code" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> length);
+<a name="l00042"></a>00042 <a class="code" href="classPacket.html#abcfb963c0d5bc0fa554668f92989622">Packet</a>(<span class="keyword">const</span> <a class="code" href="classBuffer.html">Buffer</a> &amp;src);
+<a name="l00043"></a>00043
+<a name="l00044"></a>00044 <span class="keywordtype">bool</span> <a class="code" href="classPacket.html#a004c01dd99179b0a08109dce5fc6b03">hasHeader</a>() <span class="keyword">const</span>;
+<a name="l00045"></a>00045 <a class="code" href="classPacket.html">Packet</a>&amp; <a class="code" href="classPacket.html#ce9e40180f64d44fe1d8da14ac9e5df2">withHeader</a>(<span class="keywordtype">bool</span> b);
+<a name="l00046"></a>00046 <a class="code" href="datatypes_8h.html#317be74a3176b4149a817241bd69f9b2">seq_nr_t</a> <a class="code" href="classPacket.html#6572b9df8c1f5f0de9fcb8e5c669de50">getSeqNr</a>() <span class="keyword">const</span>;
+<a name="l00047"></a>00047 <a class="code" href="datatypes_8h.html#c8be006c348a522ae126f67f7b2aaf4e">sender_id_t</a> <a class="code" href="classPacket.html#096829acfcf98c3ffff60bd335cbb919">getSenderId</a>() <span class="keyword">const</span>;
+<a name="l00048"></a>00048 <a class="code" href="classPacket.html">Packet</a>&amp; <a class="code" href="classPacket.html#2a682115c6802d0dd1ebbd3434a3a179">addHeader</a>(<a class="code" href="datatypes_8h.html#317be74a3176b4149a817241bd69f9b2">seq_nr_t</a> seq_nr, <a class="code" href="datatypes_8h.html#c8be006c348a522ae126f67f7b2aaf4e">sender_id_t</a> sender_id);
+<a name="l00049"></a>00049 <a class="code" href="classPacket.html">Packet</a>&amp; <a class="code" href="classPacket.html#24c2a41630d79411086d952c8f732c8c">removeHeader</a>();
+<a name="l00050"></a>00050 <a class="code" href="classPacket.html">Packet</a>&amp; <a class="code" href="classPacket.html#1b89ed1be19d6b9c1a12e0f6b1ae8ed2">setSeqNr</a>(<a class="code" href="datatypes_8h.html#317be74a3176b4149a817241bd69f9b2">seq_nr_t</a> seq_nr);
+<a name="l00051"></a>00051 <a class="code" href="classPacket.html">Packet</a>&amp; <a class="code" href="classPacket.html#01c7b848ec415740565c87b374085bdc">setSenderId</a>(<a class="code" href="datatypes_8h.html#c8be006c348a522ae126f67f7b2aaf4e">sender_id_t</a> sender_id);
+<a name="l00052"></a>00052
+<a name="l00053"></a>00053 <span class="keywordtype">bool</span> <a class="code" href="classPacket.html#c78b8af0dc7c7badf85e75db0de54800">hasPayloadType</a>() <span class="keyword">const</span>;
+<a name="l00054"></a>00054 <a class="code" href="classPacket.html">Packet</a>&amp; <a class="code" href="classPacket.html#c7ecfc05376afd00af89cb328e194a1d">withPayloadType</a>(<span class="keywordtype">bool</span> b);
+<a name="l00055"></a>00055 <a class="code" href="datatypes_8h.html#cb4c65fa561443848e729372d970654d">payload_type_t</a> <a class="code" href="classPacket.html#ed7f5cc79b40a11eddefd4b421544498">getPayloadType</a>() <span class="keyword">const</span>;
+<a name="l00056"></a>00056 <a class="code" href="classPacket.html">Packet</a>&amp; <a class="code" href="classPacket.html#40849ee3c59a84c3899c409ed392b477">addPayloadType</a>(<a class="code" href="datatypes_8h.html#cb4c65fa561443848e729372d970654d">payload_type_t</a> payload_type);
+<a name="l00057"></a>00057 <a class="code" href="classPacket.html">Packet</a>&amp; <a class="code" href="classPacket.html#6433e4d5eef9216f4e70b338cb4d2e4d">removePayloadType</a>();
+<a name="l00058"></a>00058
+<a name="l00059"></a>00059 <span class="keywordtype">bool</span> <a class="code" href="classPacket.html#bfe50722f18687bb0691061fb0ccb0ff">hasAuthTag</a>() <span class="keyword">const</span>;
+<a name="l00060"></a>00060 <a class="code" href="classPacket.html">Packet</a>&amp; <a class="code" href="classPacket.html#5c947adee9eef0a662a4dc49d95dbe8e">withAuthTag</a>(<span class="keywordtype">bool</span> b);
+<a name="l00061"></a>00061 <a class="code" href="datatypes_8h.html#3618ec768f7f5b8ed61f2ad534e1882d">auth_tag_t</a> <a class="code" href="classPacket.html#ba55c639065c177a7006d8392f50eddc">getAuthTag</a>() <span class="keyword">const</span>;
+<a name="l00062"></a>00062 <a class="code" href="classPacket.html">Packet</a>&amp; <a class="code" href="classPacket.html#a7f8bb4bb127aad314eb0f0ef72447ed">addAuthTag</a>(<a class="code" href="datatypes_8h.html#3618ec768f7f5b8ed61f2ad534e1882d">auth_tag_t</a> auth_tag);
+<a name="l00063"></a>00063 <a class="code" href="classPacket.html">Packet</a>&amp; <a class="code" href="classPacket.html#3e3dfca708baf59791f0608b8a57924c">removeAuthTag</a>();
+<a name="l00064"></a>00064
+<a name="l00065"></a>00065 <span class="keyword">private</span>:
+<a name="l00066"></a><a class="code" href="structPacket_1_1HeaderStruct.html">00066</a> <span class="keyword">struct </span><a class="code" href="structPacket_1_1HeaderStruct.html">HeaderStruct</a>
+<a name="l00067"></a>00067 {
+<a name="l00068"></a><a class="code" href="structPacket_1_1HeaderStruct.html#4b7b9bf68b204ca98171b7f818685521">00068</a> <a class="code" href="datatypes_8h.html#317be74a3176b4149a817241bd69f9b2">seq_nr_t</a> seq_nr;
+<a name="l00069"></a><a class="code" href="structPacket_1_1HeaderStruct.html#c129b7cda1d848a579b689bacdabddea">00069</a> <a class="code" href="datatypes_8h.html#c8be006c348a522ae126f67f7b2aaf4e">sender_id_t</a> sender_id;
+<a name="l00070"></a>00070 }__attribute__((<a class="code" href="classPacket.html#11b3534f67df6bb19963e6bc8090230b">__packed__</a>));
+<a name="l00071"></a><a class="code" href="classPacket.html#97b8eb52e7476174a0e91e2ccaf73306">00071</a> <span class="keywordtype">bool</span> <a class="code" href="classPacket.html#97b8eb52e7476174a0e91e2ccaf73306">has_header_</a>;
+<a name="l00072"></a><a class="code" href="classPacket.html#235c6c8c7362c46ca33a331713199a17">00072</a> <span class="keywordtype">bool</span> <a class="code" href="classPacket.html#235c6c8c7362c46ca33a331713199a17">has_payload_type_</a>;
+<a name="l00073"></a><a class="code" href="classPacket.html#849a965c46afc5fa7efe257212197abb">00073</a> <span class="keywordtype">bool</span> <a class="code" href="classPacket.html#849a965c46afc5fa7efe257212197abb">has_auth_tag_</a>;
+<a name="l00074"></a>00074 };
+<a name="l00075"></a>00075
+<a name="l00076"></a>00076 <span class="preprocessor">#endif</span>
+</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Oct 7 23:43:49 2007 for anytun by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
+</body>
+</html>
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-04 09:35:11 +0000