summaryrefslogtreecommitdiff
path: root/doc/html/tunDevice_8h-source.html
blob: 076134d06ed72c11e37b28c5b5605f9d51269f4c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
<!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: tunDevice.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>tunDevice.h</h1><a href="tunDevice_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 _TUNDEVICE_H_</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#define _TUNDEVICE_H_</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span>
<a name="l00034"></a>00034 <span class="preprocessor">#include "<a class="code" href="buffer_8h.html">buffer.h</a>"</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include "<a class="code" href="threadUtils_8hpp.html">threadUtils.hpp</a>"</span>
<a name="l00036"></a>00036 
<a name="l00037"></a><a class="code" href="classTunDevice.html">00037</a> <span class="keyword">class </span><a class="code" href="classTunDevice.html">TunDevice</a>
<a name="l00038"></a>00038 {
<a name="l00039"></a>00039 <span class="keyword">public</span>:
<a name="l00040"></a><a class="code" href="classTunDevice.html#ec146b27c7755747c1cc1511e4482875">00040</a>   <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> <a class="code" href="classTunDevice.html#ec146b27c7755747c1cc1511e4482875">TYPE_UNDEF</a> = 0;
<a name="l00041"></a><a class="code" href="classTunDevice.html#ea416d7f03ef22bf1d166d33b47fd993">00041</a>   <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> <a class="code" href="classTunDevice.html#ea416d7f03ef22bf1d166d33b47fd993">TYPE_TUN</a> = 1;
<a name="l00042"></a><a class="code" href="classTunDevice.html#b4ce6b158bbe4fe051b6fea8cd3d6cd3">00042</a>   <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> <a class="code" href="classTunDevice.html#b4ce6b158bbe4fe051b6fea8cd3d6cd3">TYPE_TAP</a> = 2;
<a name="l00043"></a>00043 
<a name="l00044"></a>00044   <a class="code" href="classTunDevice.html#d6914bd3a45e03ffe95676ac4420154a">TunDevice</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* dev,<span class="keyword">const</span> <span class="keywordtype">char</span>* dev_type, <span class="keyword">const</span> <span class="keywordtype">char</span>* ifcfg_lp, <span class="keyword">const</span> <span class="keywordtype">char</span>* ifcfg_rnmp);
<a name="l00045"></a>00045   <a class="code" href="classTunDevice.html#2c6196d270bf4d0e99ff4f860391faed">~TunDevice</a>();
<a name="l00046"></a>00046   
<a name="l00047"></a>00047   <span class="keywordtype">void</span> <a class="code" href="classTunDevice.html#323ddcfd4ac60d0dbfe6ebb5bbb9a323">open</a>();
<a name="l00048"></a>00048   <span class="keywordtype">void</span> <a class="code" href="classTunDevice.html#13986e13fe28da6c917293c40effb902">close</a>();
<a name="l00049"></a>00049   <span class="keywordtype">bool</span> <a class="code" href="classTunDevice.html#f63f3331789f043e44eb435b78c815b2">isOpen</a>();
<a name="l00050"></a>00050 
<a name="l00051"></a>00051   <span class="keywordtype">short</span> <a class="code" href="classTunDevice.html#553498887edc92f7b7e31e3bf04fb8fb">read</a>(<a class="code" href="classBuffer.html">Buffer</a>&amp; buf);
<a name="l00052"></a>00052   <span class="keywordtype">int</span> <a class="code" href="classTunDevice.html#958bc73a627cc5d404ed87204547134d">write</a>(<a class="code" href="classBuffer.html">Buffer</a>&amp; buf);
<a name="l00053"></a>00053 
<a name="l00054"></a>00054   <span class="keywordtype">char</span>* <a class="code" href="classTunDevice.html#e02f8972f75b11b69280fba9b6649cab">getActualName</a>();
<a name="l00055"></a>00055   <a class="code" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> <a class="code" href="classTunDevice.html#b57512464007681dcc92820adb3deb0f">getType</a>();
<a name="l00056"></a>00056   <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classTunDevice.html#eb99a885d90822b00e623ca02c2b06cc">getTypeString</a>();
<a name="l00057"></a>00057 
<a name="l00058"></a>00058 <span class="keyword">private</span>:
<a name="l00059"></a>00059   <span class="keywordtype">void</span> <a class="code" href="classTunDevice.html#de33e9a7a951b43f2f7e24d8fe9c311e">operator=</a>(<span class="keyword">const</span> <a class="code" href="classTunDevice.html">TunDevice</a> &amp;src);
<a name="l00060"></a>00060   <a class="code" href="classTunDevice.html#d6914bd3a45e03ffe95676ac4420154a">TunDevice</a>(<span class="keyword">const</span> <a class="code" href="classTunDevice.html">TunDevice</a> &amp;src);
<a name="l00061"></a>00061 
<a name="l00062"></a><a class="code" href="classTunDevice.html#e130228e28996e644d2013089e704d4c">00062</a>   <a class="code" href="classMutex.html">Mutex</a> <a class="code" href="classTunDevice.html#e130228e28996e644d2013089e704d4c">io_mutex_</a>;
<a name="l00063"></a><a class="code" href="classTunDevice.html#239c85381dfcf1776303778d1784df51">00063</a>   <span class="keyword">struct </span>tuntap *<a class="code" href="classTunDevice.html#239c85381dfcf1776303778d1784df51">dev_</a>;
<a name="l00064"></a>00064 };
<a name="l00065"></a>00065 
<a name="l00066"></a>00066 <span class="preprocessor">#endif</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Dec 3 11:49:24 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>