index.ned

//
// Copyright (C) 2000 Institut fuer Telematik, Universitaet Karlsruhe
// Copyright (C) 2003 Andras Varga
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
//


//
// @titlepage
//
// <center><h1>INET Framework for OMNeT++/OMNEST</h1></center>
// <center><h3>snapshot 2004-10-06</h3></center>
//
// <nohtml>INET Framework contains IPv4, TCP, UDP protocol implementations,
// and several application models. The framework also includes an MPLS model
// with \RSVP-TE and LDP signalling. RSVP-TE uses the CSPF, the routing
// algorithm in OSPF-TE, with bandwidth as the major resource constraint.
// Link-layer models are PPP and Ethernet.</nohtml>
//
// <a href="history.html">History and contributors</a>.
//
// For up-to-date info, visit the current
// <a href="http://ctieware.eng.monash.edu.au/twiki/bin/view/Simulation/INETFramework" target="_top">INET Framework home page</a>.
//
// A few useful starting points for browsing the documentation:
//  - the <a href="full-usage-diagram.html">Usage Diagram</a>
//    includes all modules and networks
//  - example networks: NClients, BulkTransfer, MulticastNetwork,
//    ARPTest, MixedLAN, etc.
//  - hosts, routers, switches: StandardHost, Router, EtherSwitch, EtherHub,
//    etc.
//  - protocol implementations: IP, IPProcessing, TCPMain, UDPProcessing,
//    PPPInterface, ARP, EtherMAC, etc.
//  - a central module which holds the interface table and the route table:
//    RoutingTable
//  - if you don't want to manually set up \IP addresses and routing:
//    FlatNetworkConfigurator
//  - message classes: IPDatagram, TCPSegment, UDPPacket, EthernetIIFrame,
//    ARPPacket, PPPFrame, GenericAppMsg, EtherAppReq, etc.
//  - control info classes (used in communication between protocol layers):
//    IPControlInfo, TCPCommand, UDPControlInfo, EtherCtrl, etc.
//  - application models: UDPApp, TCPSessionApp, TCPBasicClientApp,
//    TCPGenericSrvApp, TCPSinkApp, TCPSrvHostApp, EtherAppCli, EtherAppSrv,
//    etc.
//
// Starting points for the MPLS models:
//  - the core modules: MPLSModule, LIBTable, NewLDP, RSVP, TED, OspfTe
//  - MPLS-enabled routers: LDP_LSR, RSVP_LSR
//  - MPLSNet network model
//  - <a href="standards.html">list of implemented standards</a>
//
// Related documentation:
//   - <a href="../doxy/index.html" target="_top">C++ source documentation (Doxygen)</a>
//
// @page history.html, History
//
// The OMNeT++/OMNEST INET framework is a successor of the IPSuite package.
//
// The original IPSuite was written by Klaus Wehrle, Jochen Reber,
// Dirk Holzhausen, Volker Boehm, Verena Kahmann, Ulrich Kaage and others
// at the University of Karlsruhe during 2000-2001.
//
// After a period of IPSuite being unmaintained, Andras Varga took over
// the development in July 2003. Through a series of snapshot releases in
// 2003-2004, modules got completely reorganized, documented, and many of them
// rewritten from scratch. The MPLS models (see below) was also merged
// into the codebase. The complete change log is available
// <a href="http://ctieware.eng.monash.edu.au/twiki/bin/view/Simulation/IPSuiteLogOfChanges" target="_top">here</a>.
// Most notable additions are a new, modular and extensible TCP implementation,
// application models, Ethernet implementation and an all-in-one IP model
// to replace the earlier, modularized one.
//
// The package was renamed INET framework in October 2004.
//
// The MPLS, LDP and \RSVP-TE models were built as an add-on to IPSuite.
// The package consists of around 10,000 LOCs, and it was written by Xuan
// Thang Nguyen (Xuan.T.Nguyen@uts.edu.au) and other students at the University
// of Technology, Sydney under supervision of Dr Robin Brown.
// See <a href="http://charlie.it.uts.edu.au/~tkaphan/xtn/capstone/" target="_top">project page</a>
// (no longer updated).
//
// The MPLS models are now also maintained by Andras Varga, as part of the
// INET framework.
//