suse man page for gen_new_estimator

GEN_NEW_ESTIMATOR(9)						 Linux Networking					      GEN_NEW_ESTIMATOR(9)

NAME
       gen_new_estimator - create a new rate estimator

SYNOPSIS
       int gen_new_estimator(struct gnet_stats_basic_packed * bstats, struct gnet_stats_rate_est * rate_est, spinlock_t * stats_lock,
			     struct nlattr * opt);

ARGUMENTS
       bstats
	   basic statistics

       rate_est
	   rate estimator statistics

       stats_lock
	   statistics lock

       opt
	   rate estimator configuration TLV

DESCRIPTION
       Creates a new rate estimator with bstats as source and rate_est as destination. A new timer with the interval specified in the
       configuration TLV is created. Upon each interval, the latest statistics will be read from bstats and the estimated rate will be stored in
       rate_est with the statistics lock grabed during this period.

       Returns 0 on success or a negative error code.

NOTE
       Called under rtnl_mutex

COPYRIGHT
Kernel Hackers Manual 2.6.					     July 2010						      GEN_NEW_ESTIMATOR(9)