| 1 |
|
| 2 |
/** |
| 3 |
|
| 4 |
@page mainpage_class_sum Summarized Class List by Category |
| 5 |
|
| 6 |
This page contains a summarized listing of classes, please see the |
| 7 |
<a href="annotated.html"><span>Class List</span></a> |
| 8 |
page for a full listing. |
| 9 |
|
| 10 |
|
| 11 |
<table class='doctable' border='0' cellspacing='0' cellpadding='4'> |
| 12 |
<tr><td> |
| 13 |
@li @ref mainpage_core_io |
| 14 |
@li @ref mainpage_pkt_parsing |
| 15 |
</td><td> |
| 16 |
@li @ref mainpage_data_structure |
| 17 |
@li @ref mainpage_timer_classes |
| 18 |
</td><td> |
| 19 |
@li @ref mainpage_application |
| 20 |
@li @ref mainpage_helper_classes |
| 21 |
</td><td> |
| 22 |
@li @ref mainpage_manet |
| 23 |
</td></tr> |
| 24 |
</table> |
| 25 |
|
| 26 |
<hr> |
| 27 |
|
| 28 |
@section mainpage_core_io I/O Classes |
| 29 |
|
| 30 |
The following are the Protolib I/O Classes |
| 31 |
|
| 32 |
@li ProtoCap Interface class for raw MAC-layer packet capture. Platform |
| 33 |
implementations of this class vary. |
| 34 |
|
| 35 |
@li PcapCap An implementation of the ProtoCap class using "libpcap" for |
| 36 |
packet capture. |
| 37 |
|
| 38 |
@li ProtoDetour Inbound/outbound packet _interception_ class. Platform implementations |
| 39 |
vary ... but generally leverages system firewall interfaces. A Win32 version based |
| 40 |
around NDIS intermediate driver is in progress. |
| 41 |
|
| 42 |
@li ProtoChannel Base class for hooking into asynchronouse I/O (via Unix file |
| 43 |
descriptors or WIN32 HANDLEs). Used as a base class for ProtoPipe, ProtoDetour, |
| 44 |
ProtoCap, etc. |
| 45 |
|
| 46 |
@li ProtoPipe Socket-like mechanism (with both datagram and stream support) |
| 47 |
useful for interprocess communications (uses Unix domain sockets on Unix, other |
| 48 |
stuff on Win32 & WinCE). |
| 49 |
|
| 50 |
@li ProtoSocket Network socket container class that provides consistent interface |
| 51 |
for use of operating system (or simulation environment) transport sockets. |
| 52 |
|
| 53 |
@li ProtoVif Base class providing virtual interfaces support. |
| 54 |
|
| 55 |
<hr> |
| 56 |
|
| 57 |
@section mainpage_pkt_parsing Packet Parsing |
| 58 |
|
| 59 |
These are the classes relevant to packet parsing: |
| 60 |
|
| 61 |
@li ProtoPkt Base class for a suite of network protocol packet/message |
| 62 |
building/parsing classes that provide methods for setting/getting protocol |
| 63 |
field values to/from a buffer. |
| 64 |
|
| 65 |
@li ProtoPktARP Useful for building/parsing ARP packets. |
| 66 |
|
| 67 |
@li ProtoPktAUTH IPv6 Authentication Header (AUTH) extension. |
| 68 |
|
| 69 |
@li ProtoPktDPD IPv6 Simplified Multicast Forwarding Duplicate Packet |
| 70 |
Detection (DPD) option. |
| 71 |
|
| 72 |
@li ProtoPktESP IPv6 Encapsulating Security Protocol (ESP) header. |
| 73 |
|
| 74 |
@li ProtoPktETH This class provides access to and control of ETHernet |
| 75 |
header fields for the associated buffer space. |
| 76 |
|
| 77 |
@li ProtoPktFRAG Builds IPv6 FRAG extension. |
| 78 |
|
| 79 |
@li ProtoPktIP Classes are provided for building/parsing IPv4 and IPv6 packets to/from |
| 80 |
a buffer space. |
| 81 |
|
| 82 |
@li ProtoPktRTP Useful for building/parsing Real-Time Protocol(RTP), RFC3550, |
| 83 |
messages. |
| 84 |
|
| 85 |
@li ProtoPktUDP Parses UDP Packets |
| 86 |
|
| 87 |
<hr> |
| 88 |
@section mainpage_data_structure Data Structures |
| 89 |
|
| 90 |
@li ProtoList This class provides a simple double linked-list class with a |
| 91 |
ProtoList::Item base class to use for deriving your own classes you wish to |
| 92 |
store in a ProtoList. |
| 93 |
|
| 94 |
@li ProtoGraph Base class for managing graph data structures. |
| 95 |
|
| 96 |
@li ProtoRouteMgr Base class used to provide a common interface to system |
| 97 |
(or other external) router tables. Implementations for Linux, BSD (incl. MacOS), |
| 98 |
and Win32/WinCE are included. Implementations for other routing/forwarding |
| 99 |
daemons like Quagga or Xorp may be provided in the future. |
| 100 |
|
| 101 |
@li ProtoRouteTable Class based on the ProtoTree Patricia tree to store |
| 102 |
routing table information. Uses the ProtoAddress class to store network |
| 103 |
routing addresses. It's a pretty dumbed-down routing table at the moment, |
| 104 |
but may be enhanced in the future. |
| 105 |
|
| 106 |
@li ProtoSpace Maintains a set of "nodes" in two dimensional space |
| 107 |
|
| 108 |
@li ProtoSlidingMask This class provides space-efficient binary storage. |
| 109 |
|
| 110 |
@li ProtoStack The ProtoStack class is like the ProtoList and similarly provides a |
| 111 |
ProtoStackTemplate that can be used for deriving easier-to- |
| 112 |
use variants for custom items sub-classed from the ProtoStack::Item. |
| 113 |
|
| 114 |
@li ProtoTree Flexible implementation of a Patricia tree data structure. |
| 115 |
Includes a ProtoTree::Item which may be derived from or used as a container |
| 116 |
for whatever data structures and application may require. |
| 117 |
<hr> |
| 118 |
@section mainpage_timer_classes Timer Classes |
| 119 |
|
| 120 |
@li ProtoTime Provides system time conversion routines. |
| 121 |
|
| 122 |
@li ProtoTimer A generic timer class which will notify a ProtoTimer::Listener upon timeout. |
| 123 |
|
| 124 |
@li ProtoTimerMgr This class manages ProtoTimer instances when they are "activated". |
| 125 |
The ProtoDispatcher derives from this to manage ProtoTimers for an application. |
| 126 |
(The ProtoSimAgent base class contains a ProtoTimerMgr to similarly manage timers for a |
| 127 |
simulation instance). |
| 128 |
<hr> |
| 129 |
@section mainpage_application Application Classes |
| 130 |
|
| 131 |
@li ProtoApp Base class for implementing protolib-based command-line applications. |
| 132 |
|
| 133 |
@li ProtoDispatcher This class provides a core around which Unix and Win32 applications |
| 134 |
using Protolib can be implemented. |
| 135 |
|
| 136 |
@li ProtoDispatcher::Controller Handles dispatching for the ProtoDispatcher |
| 137 |
|
| 138 |
@li ProtoSimAgent Provides a base class for developing support for Protolib code in |
| 139 |
various network simulation environments (e.g. ns-2, OPNET, etc). Contains a ProtoSocket |
| 140 |
instance that acts as a liason to a corresponding simulation transport "Agent" instance. |
| 141 |
|
| 142 |
<hr> |
| 143 |
@section mainpage_helper_classes Helper Classes |
| 144 |
|
| 145 |
@li ProtoAddress Network address container class with support for IPv4, IPv6, |
| 146 |
ETH, and "SIM" address types. Also includes functions for name/address resolution. |
| 147 |
|
| 148 |
@li ProtoAddressList The "ProtoAddressList" helper class uses a Patrica tree (ProtoTree) |
| 149 |
to keep a listing of addresses. |
| 150 |
|
| 151 |
@li ProtoBitmask Classes for managing and manipulating bitmasks to maintain |
| 152 |
binary state. A "sliding" bitmask class is provided that uses a circular |
| 153 |
buffer approach to maintain continuing, sequenced state. |
| 154 |
|
| 155 |
@li ProtoDebug Set of routines useful for debugging. |
| 156 |
|
| 157 |
@li ProtoXmlTree, ProtoXmlNode Classes for parsing and creating XML content. |
| 158 |
|
| 159 |
<hr> |
| 160 |
@section mainpage_manet Manet Classes |
| 161 |
|
| 162 |
@li ManetMsg Class that implements the General packet format being developed by the |
| 163 |
IETF MANET working group (based on ProtoPkt). |
| 164 |
|
| 165 |
@li ManetPkt Manet Pakcet parsing class. |
| 166 |
|
| 167 |
@li ManetGraph Derived from ProtoGraph and uses ProtoAddress structures to provide |
| 168 |
a suitable graph structure for keeping and exploring multi-hop network state. |
| 169 |
Supports a notion of multiple interfaces per node, etc. |
| 170 |
|
| 171 |
*/ |
| 172 |
|