Exploding the Network Kit documentation into several pages.
Will need more writing... git-svn-id: file:///srv/svn/repos/haiku/trunk/current@3038 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
Philippe Houdoin
parent
6d98b4b3de
commit
6619ee31cf
146
docs/develop/net/apps.html
Normal file
146
docs/develop/net/apps.html
Normal file
@ -0,0 +1,146 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3c.org/TR/1999/REC-html401-19991224/loose.dtd">
|
||||
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>OpenBeOS Network Kit</TITLE>
|
||||
<META http-equiv=Content-Type content="text/html; charset=windows-1252">
|
||||
<STYLE type="text/css">
|
||||
body
|
||||
{
|
||||
text-indent: 0in;
|
||||
font-stretch: normal;
|
||||
text-align: left;
|
||||
font-weight: normal;
|
||||
text-decoration: none;
|
||||
font-variant: normal;
|
||||
color: #000000;
|
||||
font-size: 12pt;
|
||||
font-style: normal;
|
||||
widows: 2;
|
||||
font-family: "Century Gothic", "Trebuchet MS", "Trebuchet", "Arial", "Helvetica";
|
||||
background-color: #ffffff;
|
||||
}
|
||||
</STYLE>
|
||||
</HEAD>
|
||||
<BODY text=#000000 vLink=#0000a0 aLink=#0000ff link=#0000c0 bgColor=#ffffff>
|
||||
|
||||
<H1>OpenBeOS Network Kit</H1>
|
||||
|
||||
<P>
|
||||
<UL>
|
||||
<LI><A href="overview.html">Overview</A>
|
||||
<LI>Implementation:
|
||||
<UL>
|
||||
<LI><A href="libs.html">The shared libraries</A>
|
||||
<UL>
|
||||
<LI><A href="libs.html#libnet">libnet.so</A>
|
||||
<UL>
|
||||
<LI><A href="libs.html#sockets_api">POSIX/BSD sockets support</A>
|
||||
<LI><A href="libs.html#dns_resolver">DNS resolver</A>
|
||||
<LI><A href="libs.html#libnet_misc">Misc functions</A>
|
||||
</UL>
|
||||
<LI><A href="libs.html#libnetapi">libnetapi.so</A>
|
||||
</UL>
|
||||
<LI><A href="stack_driver.html">The stack driver</A>
|
||||
<LI><A href="stack.html">The network stack</A>
|
||||
<UL>
|
||||
<LI><A href="stack.html#core">Core module
|
||||
<LI><A href="stack.html#interfaces">Interfaces modules</A>
|
||||
<LI><A href="stack.html#protocols">Protocols modules</A>
|
||||
</UL>
|
||||
<LI><A href="apps.html">Network apps</A>
|
||||
<UL>
|
||||
<LI><A href="apps.html#preflet">The Network GUI preference app</A>
|
||||
<LI><A href="apps.html#ping">ping</A>
|
||||
<LI><A href="apps.html#ifconfig">ifconfig</A>
|
||||
<LI><A href="apps.html#route">route</A>
|
||||
<LI><A href="apps.html#traceroute">traceroute</A>
|
||||
<LI><A href="apps.html#arp">arp</A>
|
||||
</UL>
|
||||
</UL>
|
||||
</UL>
|
||||
</P>
|
||||
|
||||
<HR>
|
||||
|
||||
<!-------------------->
|
||||
<A name="overview">
|
||||
<H2>Overview</H2>
|
||||
|
||||
<P>The OpenBeOS Network Kit consists of:
|
||||
<UL>
|
||||
<LI>a modular, add-ons based <A href="#stack">network stack</A>
|
||||
<LI>two shared libraries, <A href="#libnet">libnet.so</A> and <A href="#libnetapi">libnetapi.so</A>
|
||||
<LI>a <A href="#stack_driver">stack driver</A>, acting as interface between the
|
||||
<A href="#stack">network stack</A> and <A href="#libnet">libnet.so</A>
|
||||
<LI>basic network utilities
|
||||
<LI>a modular GUI <A href="#preflet">preflet</A>
|
||||
</UL>
|
||||
</P>
|
||||
|
||||
<H3>Let's picture(s) talk</H3>
|
||||
<P>The following image shows the overall network design:</P>
|
||||
|
||||
<IMG ALT="OpenBeOS Network Kit block diagram" SRC="obos_net_stack_design_1.gif"><BR>
|
||||
|
||||
<HR>
|
||||
|
||||
<H2>Implementation</H2>
|
||||
|
||||
<UL>
|
||||
|
||||
<LI><A name="stack">
|
||||
<H3>The network stack</H3>
|
||||
<I>Location</I>: <CODE>src/add-ons/kernel/network</CODE>
|
||||
<P>Todo...</P>
|
||||
|
||||
<LI><A name="stack_driver">
|
||||
<H3>The stack driver</H3>
|
||||
<I>Location</I>: <CODE>src/add-ons/kernel/drivers/net/stack</CODE>
|
||||
<P>The stack driver is the interface between <A href="#libnet">libnet</A> and the real stack behind him,
|
||||
host by the <A href="#stack">network stack</A> kernel modules.</P>
|
||||
His purpose is multiple:
|
||||
<OL>
|
||||
<LI>Provide the sockets == file descriptors support
|
||||
<LI>Provide a support for select() on sockets
|
||||
<LI>Load the network stack at first access, and keep it that way then...
|
||||
</OL>
|
||||
</P>
|
||||
|
||||
<LI><A name="libnet">
|
||||
<H3>The libnet.so shared library</H3>
|
||||
<I>Location</I>: <CODE>src/kits/net/libnet</CODE>
|
||||
<P>This shared library is the way BeOS R5 provide the sockets POSIX/BSD API to apps. Being
|
||||
binary compatible with R5 make this library implementation tedious.</P>
|
||||
|
||||
<LI><A name="libnetapi">
|
||||
<H3>The libnetapi.so shared library</H3>
|
||||
<I>Location</I>: <CODE>src/kits/net/libnetapi</CODE>
|
||||
<P>This shared library contains thin C++ classes wrapping the C sockets POSIX/BSD API into
|
||||
these BNet* classes we're used under BeOS: look at them in your <A href="file:///boot/beos/documentation/Be%20Book/The%20Network%20Kit/index.html">
|
||||
BeBook</A></P>
|
||||
|
||||
<LI><A name="bin">
|
||||
<H3>Basic network utilities</H3>
|
||||
|
||||
<UL>
|
||||
<LI><B>ping</B><BR>
|
||||
<I>Location</I>: <CODE>src/apps/bin/ping</CODE>
|
||||
<LI><B>ifconfig</B><BR>
|
||||
<I>Location</I>: <CODE>src/apps/bin/ifconfig</CODE>
|
||||
<LI><B>route</B><BR>
|
||||
<I>Location</I>: <CODE>src/apps/bin/route</CODE>
|
||||
<LI><B>traceroute</B><BR>
|
||||
<I>Location</I>: <CODE>src/apps/bin/traceroute</CODE>
|
||||
<LI><B>arp</B><BR>
|
||||
<I>Location</I>: <CODE>src/apps/bin/arp</CODE>
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<HR>
|
||||
|
||||
<H6>Philippe Houdoin, March 24rd, 2003</H6>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -26,108 +26,43 @@ body
|
||||
|
||||
<H1>OpenBeOS Network Kit</H1>
|
||||
|
||||
<H2>Table Of Content</H2>
|
||||
|
||||
<P>
|
||||
<UL>
|
||||
<LI><A href="#overview">Overview</A>
|
||||
<LI><A href="overview.html">Overview</A>
|
||||
<LI>Implementation:
|
||||
<UL>
|
||||
<LI><A href="#stack">The network stack</A>
|
||||
<LI><A href="libs.html">The shared libraries</A>
|
||||
<UL>
|
||||
<LI><A href="#core">Core module
|
||||
<LI><A href="#interfaces">Interfaces modules</A>
|
||||
<LI><A href="#protocols">Protocols modules</A>
|
||||
<LI><A href="libs.html#libnet">libnet.so</A>
|
||||
<UL>
|
||||
<LI><A href="libs.html#sockets_api">POSIX/BSD sockets support</A>
|
||||
<LI><A href="libs.html#dns_resolver">DNS resolver</A>
|
||||
<LI><A href="libs.html#libnet_misc">Misc functions</A>
|
||||
</UL>
|
||||
<LI><A href="libs.html#libnetapi">libnetapi.so</A>
|
||||
</UL>
|
||||
<LI><A href="#stack_driver">The stack driver</A>
|
||||
<LI><A href="#libnet">The libnet.so shared library</A>
|
||||
<LI><A href="stack_driver.html">The stack driver</A>
|
||||
<LI><A href="stack.html">The network stack</A>
|
||||
<UL>
|
||||
<LI><A href="#sockets_api">POSIX/BSD sockets support</A>
|
||||
<LI><A href="#dns_resolver">DNS resolver</A>
|
||||
<LI><A href="#libnet_misc">Misc functions</A>
|
||||
<LI><A href="stack.html#core">Core module
|
||||
<LI><A href="stack.html#interfaces">Interfaces modules</A>
|
||||
<LI><A href="stack.html#protocols">Protocols modules</A>
|
||||
</UL>
|
||||
<LI><A href="#libnetapi">The libnetapi.so shared library</A>
|
||||
<LI><A href="#bin">Basic network utilities</A>
|
||||
<LI><A href="apps.html">Network apps</A>
|
||||
<UL>
|
||||
<LI><A href="#ping">ping</A>
|
||||
<LI><A href="#ifconfig">ifconfig</A>
|
||||
<LI><A href="#route">route</A>
|
||||
<LI><A href="#traceroute">traceroute</A>
|
||||
<LI><A href="#arp">arp</A>
|
||||
<LI><A href="apps.html#preflet">The Network GUI preference app</A>
|
||||
<LI><A href="apps.html#ping">ping</A>
|
||||
<LI><A href="apps.html#ifconfig">ifconfig</A>
|
||||
<LI><A href="apps.html#route">route</A>
|
||||
<LI><A href="apps.html#traceroute">traceroute</A>
|
||||
<LI><A href="apps.html#arp">arp</A>
|
||||
</UL>
|
||||
<LI><A href="#preflet">The Network GUI preference app</A>
|
||||
</UL>
|
||||
</UL>
|
||||
</P>
|
||||
|
||||
<HR>
|
||||
|
||||
<!-------------------->
|
||||
<A name="overview">
|
||||
<H2>Overview</H2>
|
||||
|
||||
<P>The OpenBeOS Network Kit consists of:
|
||||
<UL>
|
||||
<LI>a modular, add-ons based <A href="#stack">network stack</A>
|
||||
<LI>two shared libraries, <A href="#libnet">libnet.so</A> and <A href="#libnetapi">libnetapi.so</A>
|
||||
<LI>a <A href="#stack_driver">stack driver</A>, acting as interface between the
|
||||
<A href="#stack">network stack</A> and <A href="#libnet">libnet.so</A>
|
||||
<LI>basic network utilities
|
||||
<LI>a modular GUI <A href="#preflet">preflet</A>
|
||||
</UL>
|
||||
</P>
|
||||
|
||||
<H3>Let's picture(s) talk</H3>
|
||||
<P>The following image shows the overall network design:</P>
|
||||
|
||||
<IMG ALT="OpenBeOS Network Kit block diagram" SRC="obos_net_stack_design_1.gif"><BR>
|
||||
|
||||
<HR>
|
||||
|
||||
<H2>Implementation</H2>
|
||||
|
||||
<UL>
|
||||
|
||||
<LI><A name="stack">
|
||||
<H3>The network stack</H3>
|
||||
<I>Location</I>: <CODE>src/add-ons/kernel/network</CODE>
|
||||
<P>Todo...</P>
|
||||
|
||||
<LI><A name="stack_driver">
|
||||
<H3>The stack driver</H3>
|
||||
<I>Location</I>: <CODE>src/add-ons/kernel/drivers/net/stack</CODE>
|
||||
<P>Todo...</P>
|
||||
|
||||
<LI><A name="libnet">
|
||||
<H3>The libnet.so shared library</H3>
|
||||
<I>Location</I>: <CODE>src/kits/net/libnet</CODE>
|
||||
<P>Todo...</P>
|
||||
|
||||
<LI><A name="libnetapi">
|
||||
<H3>The libnetapi.so shared library</H3>
|
||||
<I>Location</I>: <CODE>src/kits/net/libnetapi</CODE>
|
||||
<P>Todo...</P>
|
||||
|
||||
<LI><A name="bin">
|
||||
<H3>Basic network utilities</H3>
|
||||
|
||||
<UL>
|
||||
<LI><B>ping</B><BR>
|
||||
<I>Location</I>: <CODE>src/apps/bin/ping</CODE>
|
||||
<LI><B>ifconfig</B><BR>
|
||||
<I>Location</I>: <CODE>src/apps/bin/ifconfig</CODE>
|
||||
<LI><B>route</B><BR>
|
||||
<I>Location</I>: <CODE>src/apps/bin/route</CODE>
|
||||
<LI><B>traceroute</B><BR>
|
||||
<I>Location</I>: <CODE>src/apps/bin/traceroute</CODE>
|
||||
<LI><B>arp</B><BR>
|
||||
<I>Location</I>: <CODE>src/apps/bin/arp</CODE>
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<HR>
|
||||
|
||||
<H6>Philippe Houdoin, March 24rd, 2003</H6>
|
||||
|
||||
</BODY>
|
||||
|
||||
51
docs/develop/net/libs.html
Normal file
51
docs/develop/net/libs.html
Normal file
@ -0,0 +1,51 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3c.org/TR/1999/REC-html401-19991224/loose.dtd">
|
||||
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>OpenBeOS Network Kit</TITLE>
|
||||
<META http-equiv=Content-Type content="text/html; charset=windows-1252">
|
||||
<STYLE type="text/css">
|
||||
body
|
||||
{
|
||||
text-indent: 0in;
|
||||
font-stretch: normal;
|
||||
text-align: left;
|
||||
font-weight: normal;
|
||||
text-decoration: none;
|
||||
font-variant: normal;
|
||||
color: #000000;
|
||||
font-size: 12pt;
|
||||
font-style: normal;
|
||||
widows: 2;
|
||||
font-family: "Century Gothic", "Trebuchet MS", "Trebuchet", "Arial", "Helvetica";
|
||||
background-color: #ffffff;
|
||||
}
|
||||
</STYLE>
|
||||
</HEAD>
|
||||
<BODY text=#000000 vLink=#0000a0 aLink=#0000ff link=#0000c0 bgColor=#ffffff>
|
||||
|
||||
<H1>OpenBeOS Network Kit: The Shared Libraries</H1>
|
||||
|
||||
<UL>
|
||||
|
||||
<LI><A name="libnet">
|
||||
<H2>The libnet.so shared library</H2>
|
||||
<I>Location</I>: <CODE>src/kits/net/libnet</CODE>
|
||||
<P>This shared library is the way BeOS R5 provide the sockets POSIX/BSD API to apps. Being
|
||||
binary compatible with R5 make this library implementation tedious.</P>
|
||||
|
||||
<LI><A name="libnetapi">
|
||||
<H2>The libnetapi.so shared library</H2>
|
||||
<I>Location</I>: <CODE>src/kits/net/libnetapi</CODE>
|
||||
<P>This shared library contains thin C++ classes wrapping the C sockets POSIX/BSD API into
|
||||
these BNet* classes we're used under BeOS: look at them in your <A href="file:///boot/beos/documentation/Be%20Book/The%20Network%20Kit/index.html">
|
||||
BeBook</A></P>
|
||||
|
||||
</UL>
|
||||
|
||||
<HR>
|
||||
|
||||
<H6>Philippe Houdoin, March 24rd, 2003</H6>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
50
docs/develop/net/overview.html
Normal file
50
docs/develop/net/overview.html
Normal file
@ -0,0 +1,50 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3c.org/TR/1999/REC-html401-19991224/loose.dtd">
|
||||
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>OpenBeOS Network Kit</TITLE>
|
||||
<META http-equiv=Content-Type content="text/html; charset=windows-1252">
|
||||
<STYLE type="text/css">
|
||||
body
|
||||
{
|
||||
text-indent: 0in;
|
||||
font-stretch: normal;
|
||||
text-align: left;
|
||||
font-weight: normal;
|
||||
text-decoration: none;
|
||||
font-variant: normal;
|
||||
color: #000000;
|
||||
font-size: 12pt;
|
||||
font-style: normal;
|
||||
widows: 2;
|
||||
font-family: "Century Gothic", "Trebuchet MS", "Trebuchet", "Arial", "Helvetica";
|
||||
background-color: #ffffff;
|
||||
}
|
||||
</STYLE>
|
||||
</HEAD>
|
||||
<BODY text=#000000 vLink=#0000a0 aLink=#0000ff link=#0000c0 bgColor=#ffffff>
|
||||
|
||||
<H1>OpenBeOS Network Kit: Overview</H1>
|
||||
|
||||
<P>The OpenBeOS Network Kit consists of:
|
||||
<UL>
|
||||
<LI>A modular, add-ons based <A href="stack.html">network stack</A>
|
||||
<LI>Two shared libraries, <A href="libs.html#libnet">libnet.so</A> and
|
||||
<A href="libs.html#libnetapi">libnetapi.so</A>
|
||||
<LI>A <A href="stack_driver.html">stack driver</A>, acting as interface between the
|
||||
<A href="stack.html">network stack</A> and <A href="libs.html#libnet">libnet.so</A>
|
||||
<LI>Basic <A href="apps.html">network apps</A>
|
||||
<LI>A modular GUI <A href="apps.html#preflet">preflet</A>
|
||||
</UL>
|
||||
</P>
|
||||
|
||||
<H2>A picture may talk better?</H2>
|
||||
<P>The following image shows the overall network design:</P>
|
||||
|
||||
<IMG ALT="OpenBeOS Network Kit block diagram" SRC="obos_net_stack_design_1.gif"><BR>
|
||||
|
||||
<HR>
|
||||
<H6>Philippe Houdoin, March 24rd, 2003</H6>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
55
docs/develop/net/stack.html
Normal file
55
docs/develop/net/stack.html
Normal file
@ -0,0 +1,55 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3c.org/TR/1999/REC-html401-19991224/loose.dtd">
|
||||
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>OpenBeOS Network Kit</TITLE>
|
||||
<META http-equiv=Content-Type content="text/html; charset=windows-1252">
|
||||
<STYLE type="text/css">
|
||||
body
|
||||
{
|
||||
text-indent: 0in;
|
||||
font-stretch: normal;
|
||||
text-align: left;
|
||||
font-weight: normal;
|
||||
text-decoration: none;
|
||||
font-variant: normal;
|
||||
color: #000000;
|
||||
font-size: 12pt;
|
||||
font-style: normal;
|
||||
widows: 2;
|
||||
font-family: "Century Gothic", "Trebuchet MS", "Trebuchet", "Arial", "Helvetica";
|
||||
background-color: #ffffff;
|
||||
}
|
||||
</STYLE>
|
||||
</HEAD>
|
||||
<BODY text=#000000 vLink=#0000a0 aLink=#0000ff link=#0000c0 bgColor=#ffffff>
|
||||
|
||||
<H1>OpenBeOS Network Kit: The Network Stack</H1>
|
||||
|
||||
<I>Location</I>: <CODE>src/add-ons/kernel/network</CODE>
|
||||
<P>[Write a short overview about it!!!]</P>
|
||||
|
||||
<UL>
|
||||
<LI><A name="core">
|
||||
<H2>Core module</H2>
|
||||
<I>Location</I>: <CODE>src/add-ons/kernel/network/core</CODE>
|
||||
<P>[Tell all about this module here!!!]</P>
|
||||
|
||||
<LI><A name="interfaces">
|
||||
<H2>Interfaces modules</H2>
|
||||
<I>Location</I>: <CODE>src/add-ons/kernel/network/interfaces</CODE>
|
||||
<P>[Tell all about these modules here!!!]</P>
|
||||
|
||||
<LI><A name="protocols">
|
||||
<H2>Protocols modules</H2>
|
||||
<I>Location</I>: <CODE>src/add-ons/kernel/network/protocols</CODE>
|
||||
<P>[Tell all about these modules here!!!]</P>
|
||||
|
||||
</UL>
|
||||
|
||||
<HR>
|
||||
|
||||
<H6>Philippe Houdoin, March 24rd, 2003</H6>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
45
docs/develop/net/stack_driver.html
Normal file
45
docs/develop/net/stack_driver.html
Normal file
@ -0,0 +1,45 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3c.org/TR/1999/REC-html401-19991224/loose.dtd">
|
||||
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>OpenBeOS Network Kit</TITLE>
|
||||
<META http-equiv=Content-Type content="text/html; charset=windows-1252">
|
||||
<STYLE type="text/css">
|
||||
body
|
||||
{
|
||||
text-indent: 0in;
|
||||
font-stretch: normal;
|
||||
text-align: left;
|
||||
font-weight: normal;
|
||||
text-decoration: none;
|
||||
font-variant: normal;
|
||||
color: #000000;
|
||||
font-size: 12pt;
|
||||
font-style: normal;
|
||||
widows: 2;
|
||||
font-family: "Century Gothic", "Trebuchet MS", "Trebuchet", "Arial", "Helvetica";
|
||||
background-color: #ffffff;
|
||||
}
|
||||
</STYLE>
|
||||
</HEAD>
|
||||
<BODY text=#000000 vLink=#0000a0 aLink=#0000ff link=#0000c0 bgColor=#ffffff>
|
||||
|
||||
<H1>OpenBeOS Network Kit: The Stack Driver</H1>
|
||||
|
||||
<I>Location</I>: <CODE>src/add-ons/kernel/drivers/net/stack</CODE>
|
||||
<P>The stack driver is the interface between <A href="libs.html#libnet">libnet</A> and the real stack behind him,
|
||||
host by the <A href="stack.html">network stack</A> kernel modules.</P>
|
||||
His purpose is multiple:
|
||||
<OL>
|
||||
<LI>Provide the sockets == file descriptors support
|
||||
<LI>Provide a support for select() on sockets
|
||||
<LI>Load the network stack at first access, and keep it that way then...
|
||||
</OL>
|
||||
</P>
|
||||
|
||||
<HR>
|
||||
|
||||
<H6>Philippe Houdoin, March 24rd, 2003</H6>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
Loading…
Reference in New Issue
Block a user