NDT-DEV email list created

Revision: 693
Author:   

Date:     Thu Oct  6 02:41:19 2011
Log:      Extended descriptions of the admin page and mrange subsystems.
http://code.google.com/p/ndt/source/detail?r=693

Modified:
 /wiki/NDTArchitecture.wiki

=======================================
--- /wiki/NDTArchitecture.wiki  Thu Oct  6 02:27:16 2011
+++ /wiki/NDTArchitecture.wiki  Thu Oct  6 02:41:19 2011
@@ -62,14 +62,14 @@
 The brief information about each of the NDT subsystem can be found in the  
following table. All source files are located in the *src* directory under  
the root of the checked out sources from the code repository.

 || *Subsystem* || *Used by* || *Description* || *Functions* || *Sources* ||
-|| logging || web100srv<br/>web100clt || Logging subsystem that is  
responsible for printing informational messages on to the console. It can  
filter messages according to the currently set debug level. Moreover, this  
subsystem is also responsible for dates/timestamps handling. || {{{void  
log_init(char* progname, int debuglvl)}}}<br/>{{{void set_debuglvl(int  
debuglvl); void set_logfile(char* filename)}}}<br/>{{{int  
get_debuglvl()}}}<br/>{{{char* get_logfile()}}}<br/>{{{I2ErrHandle  
get_errhandle()}}}<br/>{{{void log_print(int lvl, const char*  
format, ...)}}}<br/>{{{void log_println(int lvl, const char*  
format, ...)}}}<br/>{{{void log_free(void)}}}<br/>{{{void  
set_timestamp()}}}<br/>{{{time_t get_timestamp()}}}<br/>{{{long int  
get_utimestamp()}}}<br/>{{{char * get_ISOtime(char *  
isoTime)}}}<br/>{{{void   get_YYYY(char * year)}}}<br/>{{{void    
get_MM(char * month)}}}<br/>{{{void   get_DD(char * day)}}} || {{{logging.c  
logging.h}}} ||
+|| logging || web100srv<br/>web100clt || Logging subsystem that is  
responsible for printing informational messages on to the console. It can  
filter messages according to the currently set debug level. Moreover, this  
subsystem is also responsible for dates/timestamps handling. || {{{void  
log_init(char* progname, int debuglvl)}}}<br/>{{{void set_debuglvl(int  
debuglvl); void set_logfile(char* filename)}}}<br/>{{{int  
get_debuglvl()}}}<br/>{{{char* get_logfile()}}}<br/>{{{I2ErrHandle  
get_errhandle()}}}<br/>{{{void log_print(int lvl, const char*  
format, ...)}}}<br/>{{{void log_println(int lvl, const char*  
format, ...)}}}<br/>{{{void log_free(void)}}}<br/>{{{void  
set_timestamp()}}}<br/>{{{time_t get_timestamp()}}}<br/>{{{long int  
get_utimestamp()}}}<br/>{{{char* get_ISOtime(char *  
isoTime)}}}<br/>{{{void   get_YYYY(char * year)}}}<br/>{{{void    
get_MM(char * month)}}}<br/>{{{void   get_DD(char * day)}}} || {{{logging.c  
logging.h}}} ||
 || network || web100srv<br/>web100clt || Subsystem that is responsible for  
all network operations. || {{{I2Addr CreateListenSocket(I2Addr addr, char*  
serv, int options, int buf_size)}}}<br/>{{{int CreateConnectSocket(int*  
sockfd, I2Addr local_addr, I2Addr server_addr, int option, int  
buf_sizes)}}}<br/>{{{int send_msg(int ctlSocket, int type, void* msg, int  
len)}}}<br/>{{{int recv_msg(int ctlSocket, int* type, void* msg, int*  
len)}}}<br/>{{{int writen(int fd, void* buf, int amount)}}}<br/>{{{int  
readn(int fd, void* buf, int amount)}}} || {{{network.c network.h}}} ||
 || protocol || web100srv<br/>web100clt || Functions to support  
[NDTProtocol NDT Protocol]. || {{{int check_msg_type(char* prefix, int  
expected, int received, char* buff, int len)}}} || {{{protocol.c  
protocol.h}}} ||
 || utils || web100srv<br/>web100clt || Functions to handle numbers sanity  
checks and some other utility things. || {{{int check_int(char* text, int*  
number)}}}<br/>{{{int check_rint(char* text, int* number, int minVal, int  
maxVal)}}}<br/>{{{int check_long(char* text, long* number)}}}<br/>{{{double  
secs()}}}<br/>{{{void err_sys(char* s)}}}<br/>{{{int sndq_len(int  
fd)}}}<br/>{{{void mysleep(double time)}}} || utils.c utils.h ||
 || Web100 support || web100srv || Functions needed to read the Web100  
variables. || {{{web100_get_data_recv(int sock, web100_agent* agent,  
web100_connection* cn, int  
count_vars)}}}<br/>{{{web100_get_data(web100_snapshot* snap, int ctlsock,  
web100_agent* agent, int count_vars)}}} || {{{web100-util.c web100srv.h}}} | 
|
 || pcap support || web100srv || Functions that use pcap library in the  
bottleneck detection algorithm. || {{{print_speed(u_char *user, const  
struct pcap_pkthdr *h, const u_char *p)}}}<br/>{{{void calculate_spd(struct  
spdpair *cur, struct spdpair *cur2, int portA, int portB)}}} ||  
{{{web100-pcap.c web100srv.h}}} ||
-|| admin page || web100srv || Functions needed to handle the Admin page,  
which allows a remote user to view the usage statistics via a web page. ||  
{{{gen_html(int c2sspd, int s2cspd, int MinRTT, int PktsRetrans, int  
Timeouts, int Sndbuf, int MaxRwinRcvd, int CurrentCwnd, int mismatch, int  
bad_cable, int totalcnt, int refresh)}}} || {{{web100-admin.c  
web100-admin.h}}} ||
-|| mrange || web100srv || Functions to handle port number ranges. This  
means that the numbers generated by these methods are always between 1 and  
65535 inclusive. || {{{mrange_parse(char* text)}}}<br/>{{{mrange_next(char*  
port)}}} || {{{mrange.c mrange.h}}} ||
+|| admin page || web100srv || Functions needed to handle the Admin page,  
which allows a remote user to view the usage statistics via a web page. ||  
{{{void }}}*view_init*{{{(int refresh)}}}<br/>{{{int }}}*calculate*{{{(char  
now[32], int SumRTT, int CountRTT, int CongestionSignals, int PktsOut, int  
DupAcksIn, int AckPktsIn, int CurrentMSS, int SndLimTimeRwin, int  
SndLimTimeCwnd, int SndLimTimeSender, int MaxRwinRcvd, int CurrentCwnd, int  
Sndbuf, int DataBytesOut, int mismatch, int bad_cable, int c2sspd, int  
s2cspd, int c2sdata, int s2cack, int view_flag)}}}<br/>{{{void  
}}}*gen_html*{{{(int c2sspd, int s2cspd, int MinRTT, int PktsRetrans, int  
Timeouts, int Sndbuf, int MaxRwinRcvd, int CurrentCwnd, int mismatch, int  
bad_cable, int totalcnt, int refresh)}}} || {{{web100-admin.c  
web100-admin.h}}} ||
+|| mrange || web100srv || Functions to handle port number ranges. This  
means that the numbers generated by these methods are always between 1 and  
65535 inclusive. || {{{int }}}*mrange_parse*{{{(char* text)}}}<br/>{{{char*  
}}}*mrange_next*{{{(char* port)}}} || {{{mrange.c mrange.h}}} ||
 || || || || || ||
 || SFW Test (C) || web100clt || The client part of the Simple Firewall  
Test || {{{test_sfw_clt(int ctlsockfd, char tests, char* host, int  
conn_options)}}} || {{{test_sfw_clt.c test_sfw.h}}} ||
 || SFW Test (S) || web100srv || The server part of the Simple Firewall  
Test || {{{test_sfw_srv(int ctlsockfd, web100_agent* agent, TestOptions*  
options, int conn_options)}}} || {{{test_sfw_srv.c test_sfw.h  
testoptions.h}}} ||