Program B Documentation

Last Update:	Wed, Apr 28, 2004 (1130 AM)

[[ NOTE:  You can just replace the bracketed parts with what is being
	requested.
]]

1.	Program Status

	[[ State explicitly if your program is bug free or not.
		If not bug free, list the problem(s).
		If you have clear conjectures as to the causes of the problems,
		list them.
	]]

2.	Overview

  2.1	Shar Inventory

	[[ Provide a list of files grouped by type (source code, test scripts, etc.). ]]

  2.2	How to Build the Executables

	[[ Give instructions on how to build each executable.  Hopefully, I
		only need to enter 'make'.
	]]

  2.3	How to Run a Simple Test

	[[ Describe how to run a simple test.  It would be really great if you
		provided a script(s) to do this or I could just enter something
		like 'make mytest'.  Describe briefly what the test parameters
		are.
	]]

3.	Protocol Description

  3.1	Protcol Overview

	[[ Briefly describe main features of your protocol.  Also, describe
		how they were implemented if the approach is not obvious.
	]]

  3.2	Packet Header

	[[ Describe any changes you made to the packet header.
		Leave this blank if there is nothing to say. 
	]]

  3.3	Major Data Structures (Classes)

	[[ Summarize the major data structures; e.g., give the class name
		and a 1 or 2 sentence description of its purpose.
	]]

4.	Program Testing

  4.1	Overview

	[[ What was your testing procedure and what major tests did you run?
		Why should I be confident that your program runs correctly?
		Explain what features were exercised and which were not.
	]]

  4.2	Case 1 (Default parameters except for the sender parameters
  	'-w 8', '-n 16' packets)

	[[ Explain why the verbose trace output for this case is correct.
	]]

  4.3	Case 2 (Same as Case 1 except for the netsim parameters
  	'-3 0.1' and '-4 0.1')

	[[ Explain why the verbose trace output for this case is correct.
	]]
		
5.	Netsim Experimental Results

  5.1	Experiments:

	[[ Where did you run the experiments (e.g., system, OS)?
		What experiments did you run?
		How did you measure time?
	]]

  5.2	Results (Presentation/Discussion}:

	[[ Fill out the table in Appendix B. ]]

	[[ Discuss why your results make sense.  Compare the error-free
		results to theory.  Did you get the results you expected?
		If not, give a possible explanation.  Are your results
		reproducible?
	]]

  5.3	Additional Results (If Any)

	[[ Present and discuss any additional results that are interesting. ]]

Appendix A: Source Code Listing

	Table of Contents:  Provide a list of the attached files
	Listings:  Attach the printouts in the order specified in the
		Table of Contents.

Appendix B: Table of Measurement Results

	[[ EXTRA means extra credit ]]

						ETR (Kbps)
	Exp#	(p1,p2,p3,p4)	    W	Run 1	Run 2	Run 3	Avg
	-------------------------------------------------------------
	1	0, 0, 0, 0	    1	XXXXX	XXXXX	XXXXX	XXXXX
EXTRA	2	0, 0, 0, 0	    8	XXXXX	XXXXX	XXXXX	XXXXX
	3	0, 0, 0, 0	    64	XXXXX	XXXXX	XXXXX	XXXXX
	-------------------------------------------------------------
	4	0.0002, 0.1, 0, 0    1	XXXXX	XXXXX	XXXXX	XXXXX
EXTRA	5	0.0002, 0.1, 0, 0    8	XXXXX	XXXXX	XXXXX	XXXXX
	6	0.0002, 0.1, 0, 0    64	XXXXX	XXXXX	XXXXX	XXXXX
	-------------------------------------------------------------
	7	0, 0.1, 0.0002, 0    1	XXXXX	XXXXX	XXXXX	XXXXX
EXTRA	8	0, 0.1, 0.0002, 0    8	XXXXX	XXXXX	XXXXX	XXXXX
	9	0, 0.1, 0.0002, 0    64	XXXXX	XXXXX	XXXXX	XXXXX
	-------------------------------------------------------------
	10	0.0002,0.1,0.0002,0  1	XXXXX	XXXXX	XXXXX	XXXXX
EXTRA	11	0.0002,0.1,0.0002,0  8	XXXXX	XXXXX	XXXXX	XXXXX
	12	0.0002,0.1,0.0002,0  64	XXXXX	XXXXX	XXXXX	XXXXX
	-------------------------------------------------------------

Appendix C: XXXXX

	Put other details in additional appendices as needed.