NDT-DEV email list created

Revision: 696
Author:   

Date:     Thu Oct  6 03:30:06 2011
Log:      Highlighted all subsystems' functions.
http://code.google.com/p/ndt/source/detail?r=696

Modified:
 /wiki/NDTArchitecture.wiki

=======================================
--- /wiki/NDTArchitecture.wiki  Thu Oct  6 03:15:13 2011
+++ /wiki/NDTArchitecture.wiki  Thu Oct  6 03:30:06 2011
@@ -62,10 +62,10 @@
 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}}} ||
-|| 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 ||
+|| 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)}}}<br/>{{{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. || {{{void }}}*get_iflist*{{{(void)}}}<br/>{{{int  
}}}*web100_init*{{{(char *VarFileName)}}}<br/>{{{int  
}}}*web100_autotune*{{{(int sock, web100_agent* agent, web100_connection*  
cn)}}}<br/>{{{void }}}*web100_middlebox*{{{(int sock, web100_agent* agent,  
web100_connection* cn, char *results)}}}<br/>{{{int  
}}}*web100_setbuff*{{{(int sock, web100_agent* agent, web100_connection*  
cn, int autotune)}}}<br/>{{{void }}}*web100_get_data_recv*{{{(int sock,  
web100_agent* agent, web100_connection* cn, int count_vars)}}}<br/>{{{int  
}}}*web100_get_data*{{{(web100_snapshot* snap, int ctlsock, web100_agent*  
agent, int count_vars)}}}<br/>{{{int }}}*!CwndDecrease*{{{(web100_agent*  
agent, char* logname, int *dec_cnt, int *same_cnt, int  
*inc_cnt)}}}<br/>{{{int }}}*web100_logvars*{{{(int *Timeouts, int *SumRTT,  
int *CountRTT, int *PktsRetrans, int *FastRetran, int *DataPktsOut, int  
*AckPktsOut, int *CurrentMSS, int *DupAcksIn, int *AckPktsIn, int  
*MaxRwinRcvd, int *Sndbuf, int *CurrentCwnd, int *SndLimTimeRwin, int  
*SndLimTimeCwnd, int *SndLimTimeSender, int *DataBytesOut, int  
*SndLimTransRwin, int *SndLimTransCwnd, int *SndLimTransSender, int  
*MaxSsthresh, int *CurrentRTO, int *CurrentRwinRcvd, int *MaxCwnd, int  
*CongestionSignals, int *PktsOut, int *MinRTT, int count_vars, int  
*RcvWinScale, int *SndWinScale, int *CongAvoid, int *CongestionOverCount,  
int *MaxRTT, int *OtherReductions, int *CurTimeoutCount, int  
*AbruptTimeouts, int *SendStall, int *SlowStart, int *SubsequentTimeouts,  
int *ThruBytesAcked)}}} || {{{web100-util.c web100srv.h}}} ||
 || pcap support || web100srv || Functions that use pcap library in the  
bottleneck detection algorithm. || {{{void }}}*init_vars*{{{(struct spdpair  
*cur)}}}<br/>{{{void }}}*print_bins*{{{(struct spdpair *cur, int  
monitor_pipe[2])}}}<br/>{{{void }}}*calculate_spd*{{{(struct spdpair *cur,  
struct spdpair *cur2, int port2, int port3)}}}<br/>{{{void  
}}}*init_pkttrace*{{{(I2Addr srcAddr, struct sockaddr *sock_addr, socklen_t  
saddrlen, int monitor_pipe[2], char *device, PortPair* pair, char *  
direction, int compress)}}}<br/>{{{int }}}*check_signal_flags*{{{()}}} ||  
{{{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. ||  
{{{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}}} ||