1.1 --- a/doc/tutorial/introduction.texi Sun Feb 03 18:50:55 2008 +0000
1.2 +++ b/doc/tutorial/introduction.texi Sun Feb 03 19:05:37 2008 +0000
1.3 @@ -14,7 +14,7 @@
1.4 simulator targeted primarily for research and educational use.
1.5 The @uref{http://www.nsnam.org,,@command{ns-3} project}, started in
1.6 2006, is an open-source project. The goal of the project is to
1.7 -build a new netework simulator primarily for research and educational use.
1.8 +build a new network simulator primarily for research and educational use.
1.9
1.10 The purpose of this tutorial is to introduce new @command{ns-3} users to the
1.11 system in a structured way. It is sometimes difficult for new users to
1.12 @@ -31,14 +31,14 @@
1.13 Primary documentation for the @command{ns-3} project is available in
1.14 three forms:
1.15 @itemize @bullet
1.16 -@item ns-3 Manual: Documentation of the public APIs of the simulator
1.17 +@item @uref{http://www.nsnam.org/doxygen/index.html,,ns-3 Doxygen/Manual}: Documentation of the public APIs of the simulator
1.18 @item Tutorial (this document)
1.19 -@item ns-3 wiki (http://www.nsnam.org/wiki/index.php)
1.20 +@item @uref{http://www.nsnam.org/wiki/index.php,, ns-3 wiki}
1.21 @end itemize
1.22 -
1.23 +
1.24 A few key points are worth noting at the onset:
1.25 @itemize @bullet
1.26 -@item @command{ns-3} is not an extension of @command{ns-2}; it is a new
1.27 +@item @command{ns-3} is not an extension of @uref{http://www.isi.edu/nsnam/ns,,ns-2}; it is a new
1.28 simulator. The two simulators are both written in C++ but @command{ns-3}
1.29 is a new simulator that does not support the @command{ns-2} APIs.
1.30 Some models from @command{ns-2} have already been ported from @command{ns-2}
1.31 @@ -322,11 +322,11 @@
1.32 that covers material you may need to understand for the multicast examples.
1.33
1.34 @c ========================================================================
1.35 -@c The Basics
1.36 +@c Downloading and Compiling
1.37 @c ========================================================================
1.38
1.39 -@node The-Basics
1.40 -@chapter The Basics
1.41 +@node Downloading and Compiling
1.42 +@chapter Downloading and Compiling
1.43
1.44 @cindex Linux
1.45 @cindex Cygwin
2.1 --- a/doc/tutorial/tutorial.texi Sun Feb 03 18:50:55 2008 +0000
2.2 +++ b/doc/tutorial/tutorial.texi Sun Feb 03 19:05:37 2008 +0000
2.3 @@ -80,7 +80,7 @@
2.4 Part 1: Overview
2.5 * Overview::
2.6 * Resources::
2.7 -* The-Basics::
2.8 +* Downloading and Compiling::
2.9 * Some-Prerequisites::
2.10 * A-First-ns-3-Script::
2.11 Part 2: Details
3.1 --- a/src/node/socket.h Sun Feb 03 18:50:55 2008 +0000
3.2 +++ b/src/node/socket.h Sun Feb 03 19:05:37 2008 +0000
3.3 @@ -78,21 +78,24 @@
3.4 * \param closeCompleted Callback invoked when the close operation is
3.5 * completed.
3.6 */
3.7 - void SetCloseCallback (Callback<void,Ptr<Socket> > closeCompleted);
3.8 + void SetCloseCallback (Callback<void, Ptr<Socket> > closeCompleted);
3.9
3.10 /**
3.11 - * \param connectionSucceeded this callback is invoked when the connection request
3.12 - * initiated by the user is successfully completed. The callback is passed
3.13 - * back a pointer to the same socket object.
3.14 - * \param connectionFailed this callback is invoked when the connection request
3.15 - * initiated by the user is unsuccessfully completed. The callback is passed
3.16 - * back a pointer to the same socket object.
3.17 - * \param halfClose XXX When exactly is this callback invoked ? If it invoked when the
3.18 - * other side closes the connection ? Or when I call Close ?
3.19 + * \param connectionSucceeded this callback is invoked when the
3.20 + * connection request initiated by the user is successfully
3.21 + * completed. The callback is passed back a pointer to
3.22 + * the same socket object.
3.23 + * \param connectionFailed this callback is invoked when the
3.24 + * connection request initiated by the user is unsuccessfully
3.25 + * completed. The callback is passed back a pointer to the
3.26 + * same socket object.
3.27 + * \param halfClose XXX When exactly is this callback invoked? If
3.28 + * it invoked when the other side closes the connection ?
3.29 + * Or when I call Close ?
3.30 */
3.31 void SetConnectCallback (Callback<void, Ptr<Socket> > connectionSucceeded,
3.32 - Callback<void, Ptr<Socket> > connectionFailed,
3.33 - Callback<void, Ptr<Socket> > halfClose);
3.34 + Callback<void, Ptr<Socket> > connectionFailed,
3.35 + Callback<void, Ptr<Socket> > halfClose);
3.36 /**
3.37 * \brief Accept connection requests from remote hosts
3.38 * \param connectionRequest Callback for connection request from peer.
3.39 @@ -100,28 +103,31 @@
3.40 * ip address and the port number of the connection originator.
3.41 * This callback must return true to accept the incoming connection,
3.42 * false otherwise. If the connection is accepted, the
3.43 - * "newConnectionCreated" callback will be invoked later to give access
3.44 - * to the user to the socket created to match this new connection. If the
3.45 - * user does not explicitely specify this callback, all incoming
3.46 - * connections will be refused.
3.47 + * "newConnectionCreated" callback will be invoked later to
3.48 + * give access to the user to the socket created to match
3.49 + * this new connection. If the user does not explicitly
3.50 + * specify this callback, all incoming connections will be refused.
3.51 * \param newConnectionCreated Callback for new connection: when a new
3.52 * is accepted, it is created and the corresponding socket is passed
3.53 - * back to the user through this callback. This user callback is passed
3.54 - * a pointer to the new socket, and the ip address and port number
3.55 - * of the connection originator.
3.56 + * back to the user through this callback. This user callback is
3.57 + * passed a pointer to the new socket, and the ip address and
3.58 + * port number of the connection originator.
3.59 * \param closeRequested Callback for connection close request from peer.
3.60 * XXX: when is this callback invoked ?
3.61 */
3.62 - void SetAcceptCallback (Callback<bool, Ptr<Socket>, const Address &> connectionRequest,
3.63 - Callback<void, Ptr<Socket>, const Address&> newConnectionCreated,
3.64 - Callback<void, Ptr<Socket> > closeRequested);
3.65 + void SetAcceptCallback (Callback<bool, Ptr<Socket>,
3.66 + const Address &> connectionRequest,
3.67 + Callback<void, Ptr<Socket>,
3.68 + const Address&> newConnectionCreated,
3.69 + Callback<void, Ptr<Socket> > closeRequested);
3.70 void SetSendCallback (Callback<void, Ptr<Socket>, uint32_t> dataSent);
3.71 /**
3.72 * \brief Receive data
3.73 * \param receivedData Invoked whenever new data is received.
3.74 *
3.75 */
3.76 - void SetRecvCallback (Callback<void, Ptr<Socket>, Ptr<Packet>,const Address&> receivedData);
3.77 + void SetRecvCallback (Callback<void, Ptr<Socket>, Ptr<Packet>,
3.78 + const Address&> receivedData);
3.79
3.80 /**
3.81 * \param address the address to try to allocate