diff options
Diffstat (limited to 'doc/html/classTunDevice.html')
| -rw-r--r-- | doc/html/classTunDevice.html | 402 |
1 files changed, 402 insertions, 0 deletions
diff --git a/doc/html/classTunDevice.html b/doc/html/classTunDevice.html new file mode 100644 index 0000000..5b88069 --- /dev/null +++ b/doc/html/classTunDevice.html @@ -0,0 +1,402 @@ +<!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 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.1 --> +<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 id="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> +<h1>TunDevice Class Reference</h1><!-- doxytag: class="TunDevice" --><code>#include <<a class="el" href="tunDevice_8h-source.html">tunDevice.h</a>></code> +<p> +<a href="classTunDevice-members.html">List of all members.</a><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="classTunDevice.html#d6914bd3a45e03ffe95676ac4420154a">TunDevice</a> (const char *dev, const char *dev_type, const char *ifcfg_lp, const char *ifcfg_rnmp)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTunDevice.html#2c6196d270bf4d0e99ff4f860391faed">~TunDevice</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTunDevice.html#323ddcfd4ac60d0dbfe6ebb5bbb9a323">open</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTunDevice.html#13986e13fe28da6c917293c40effb902">close</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTunDevice.html#f63f3331789f043e44eb435b78c815b2">isOpen</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">short </td><td class="memItemRight" valign="bottom"><a class="el" href="classTunDevice.html#553498887edc92f7b7e31e3bf04fb8fb">read</a> (<a class="el" href="classBuffer.html">Buffer</a> &buf)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTunDevice.html#958bc73a627cc5d404ed87204547134d">write</a> (<a class="el" href="classBuffer.html">Buffer</a> &buf)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTunDevice.html#e02f8972f75b11b69280fba9b6649cab">getActualName</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTunDevice.html#b57512464007681dcc92820adb3deb0f">getType</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTunDevice.html#0cecbc6a7e58d294dd005e7d523173bd">getTypeString</a> ()</td></tr> + +<tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTunDevice.html#ec146b27c7755747c1cc1511e4482875">TYPE_UNDEF</a> = 0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTunDevice.html#ea416d7f03ef22bf1d166d33b47fd993">TYPE_TUN</a> = 1</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTunDevice.html#b4ce6b158bbe4fe051b6fea8cd3d6cd3">TYPE_TAP</a> = 2</td></tr> + +<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTunDevice.html#de33e9a7a951b43f2f7e24d8fe9c311e">operator=</a> (const <a class="el" href="classTunDevice.html">TunDevice</a> &src)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTunDevice.html#4587b54228b4240334ad4614211df394">TunDevice</a> (const <a class="el" href="classTunDevice.html">TunDevice</a> &src)</td></tr> + +<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classMutex.html">Mutex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTunDevice.html#e130228e28996e644d2013089e704d4c">io_mutex_</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">tuntap * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTunDevice.html#239c85381dfcf1776303778d1784df51">dev_</a></td></tr> + +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="d6914bd3a45e03ffe95676ac4420154a"></a><!-- doxytag: member="TunDevice::TunDevice" ref="d6914bd3a45e03ffe95676ac4420154a" args="(const char *dev, const char *dev_type, const char *ifcfg_lp, const char *ifcfg_rnmp)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">TunDevice::TunDevice </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>dev</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>dev_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>ifcfg_lp</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>ifcfg_rnmp</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="2c6196d270bf4d0e99ff4f860391faed"></a><!-- doxytag: member="TunDevice::~TunDevice" ref="2c6196d270bf4d0e99ff4f860391faed" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">TunDevice::~TunDevice </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="4587b54228b4240334ad4614211df394"></a><!-- doxytag: member="TunDevice::TunDevice" ref="4587b54228b4240334ad4614211df394" args="(const TunDevice &src)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">TunDevice::TunDevice </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classTunDevice.html">TunDevice</a> & </td> + <td class="paramname"> <em>src</em> </td> + <td> ) </td> + <td width="100%"><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="323ddcfd4ac60d0dbfe6ebb5bbb9a323"></a><!-- doxytag: member="TunDevice::open" ref="323ddcfd4ac60d0dbfe6ebb5bbb9a323" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void TunDevice::open </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="13986e13fe28da6c917293c40effb902"></a><!-- doxytag: member="TunDevice::close" ref="13986e13fe28da6c917293c40effb902" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void TunDevice::close </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="f63f3331789f043e44eb435b78c815b2"></a><!-- doxytag: member="TunDevice::isOpen" ref="f63f3331789f043e44eb435b78c815b2" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool TunDevice::isOpen </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="553498887edc92f7b7e31e3bf04fb8fb"></a><!-- doxytag: member="TunDevice::read" ref="553498887edc92f7b7e31e3bf04fb8fb" args="(Buffer &buf)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">short TunDevice::read </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classBuffer.html">Buffer</a> & </td> + <td class="paramname"> <em>buf</em> </td> + <td> ) </td> + <td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="958bc73a627cc5d404ed87204547134d"></a><!-- doxytag: member="TunDevice::write" ref="958bc73a627cc5d404ed87204547134d" args="(Buffer &buf)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int TunDevice::write </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classBuffer.html">Buffer</a> & </td> + <td class="paramname"> <em>buf</em> </td> + <td> ) </td> + <td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="e02f8972f75b11b69280fba9b6649cab"></a><!-- doxytag: member="TunDevice::getActualName" ref="e02f8972f75b11b69280fba9b6649cab" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char * TunDevice::getActualName </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="b57512464007681dcc92820adb3deb0f"></a><!-- doxytag: member="TunDevice::getType" ref="b57512464007681dcc92820adb3deb0f" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> TunDevice::getType </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="0cecbc6a7e58d294dd005e7d523173bd"></a><!-- doxytag: member="TunDevice::getTypeString" ref="0cecbc6a7e58d294dd005e7d523173bd" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char * TunDevice::getTypeString </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="de33e9a7a951b43f2f7e24d8fe9c311e"></a><!-- doxytag: member="TunDevice::operator=" ref="de33e9a7a951b43f2f7e24d8fe9c311e" args="(const TunDevice &src)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void TunDevice::operator= </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classTunDevice.html">TunDevice</a> & </td> + <td class="paramname"> <em>src</em> </td> + <td> ) </td> + <td width="100%"><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="ec146b27c7755747c1cc1511e4482875"></a><!-- doxytag: member="TunDevice::TYPE_UNDEF" ref="ec146b27c7755747c1cc1511e4482875" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const <a class="el" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> <a class="el" href="classTunDevice.html#ec146b27c7755747c1cc1511e4482875">TunDevice::TYPE_UNDEF</a> = 0<code> [static]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="ea416d7f03ef22bf1d166d33b47fd993"></a><!-- doxytag: member="TunDevice::TYPE_TUN" ref="ea416d7f03ef22bf1d166d33b47fd993" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const <a class="el" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> <a class="el" href="classTunDevice.html#ea416d7f03ef22bf1d166d33b47fd993">TunDevice::TYPE_TUN</a> = 1<code> [static]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="b4ce6b158bbe4fe051b6fea8cd3d6cd3"></a><!-- doxytag: member="TunDevice::TYPE_TAP" ref="b4ce6b158bbe4fe051b6fea8cd3d6cd3" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const <a class="el" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> <a class="el" href="classTunDevice.html#b4ce6b158bbe4fe051b6fea8cd3d6cd3">TunDevice::TYPE_TAP</a> = 2<code> [static]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="e130228e28996e644d2013089e704d4c"></a><!-- doxytag: member="TunDevice::io_mutex_" ref="e130228e28996e644d2013089e704d4c" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classMutex.html">Mutex</a> <a class="el" href="classTunDevice.html#e130228e28996e644d2013089e704d4c">TunDevice::io_mutex_</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="239c85381dfcf1776303778d1784df51"></a><!-- doxytag: member="TunDevice::dev_" ref="239c85381dfcf1776303778d1784df51" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct tuntap* <a class="el" href="classTunDevice.html#239c85381dfcf1776303778d1784df51">TunDevice::dev_</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="tunDevice_8h-source.html">tunDevice.h</a><li><a class="el" href="tunDevice_8cpp.html">tunDevice.cpp</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Sun Oct 7 23:43:50 2007 for anytun by +<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> |