Token Bucket Filter (TBF)
[Queueing Discipline Modules]


Attribute Access

int rtnl_qdisc_tbf_set_limit (struct rtnl_qdisc *qdisc, int limit)
 Set limit of TBF qdisc.
int rtnl_qdisc_tbf_set_limit_by_latency (struct rtnl_qdisc *qdisc, int latency)
 Set limit of TBF qdisc by latency.
int rtnl_qdisc_tbf_get_limit (struct rtnl_qdisc *qdisc)
 Get limit of TBF qdisc.
int rtnl_qdisc_tbf_set_mpu (struct rtnl_qdisc *qdisc, int mpu)
 Set MPU of TBF qdisc.
int rtnl_qdisc_tbf_get_mpu (struct rtnl_qdisc *qdisc)
 Get MPU of TBF qdisc.
int rtnl_qdisc_tbf_set_rate (struct rtnl_qdisc *qdisc, int rate, int bucket, int cell)
 Set rate of TBF qdisc.
int rtnl_qdisc_tbf_get_rate (struct rtnl_qdisc *qdisc)
 Get rate of TBF qdisc.
int rtnl_qdisc_tbf_get_rate_bucket (struct rtnl_qdisc *qdisc)
 Get rate bucket size of TBF qdisc.
int rtnl_qdisc_tbf_get_rate_cell (struct rtnl_qdisc *qdisc)
 Get rate cell size of TBF qdisc.
int rtnl_qdisc_tbf_set_peakrate (struct rtnl_qdisc *qdisc, int rate, int bucket, int cell)
 Set peak rate of TBF qdisc.
int rtnl_qdisc_tbf_get_peakrate (struct rtnl_qdisc *qdisc)
 Get peak rate of TBF qdisc.
int rtnl_qdisc_tbf_get_peakrate_bucket (struct rtnl_qdisc *qdisc)
 Get peak rate bucket size of TBF qdisc.
int rtnl_qdisc_tbf_get_peakrate_cell (struct rtnl_qdisc *qdisc)
 Get peak rate cell size of TBF qdisc.

Function Documentation

int rtnl_qdisc_tbf_set_limit ( struct rtnl_qdisc *  qdisc,
int  limit 
)

Parameters:
qdisc TBF qdisc to be modified.
limit New limit in bytes.
Returns:
0 on success or a negative error code.

Definition at line 223 of file tbf.c.

Referenced by rtnl_qdisc_tbf_set_limit_by_latency().

int rtnl_qdisc_tbf_set_limit_by_latency ( struct rtnl_qdisc *  qdisc,
int  latency 
)

Parameters:
qdisc TBF qdisc to be modified.
latency Latency in micro seconds.
Calculates and sets the limit based on the desired latency and the configured rate and peak rate. In order for this operation to succeed, the rate and if required the peak rate must have been set in advance.

\[ limit_n = \frac{{rate_n} \times {latency}}{10^6}+{bucketsize}_n \]

\[ limit = min(limit_{rate},limit_{peak}) \]

Returns:
0 on success or a negative error code.

Definition at line 266 of file tbf.c.

References rtnl_qdisc_tbf_set_limit().

int rtnl_qdisc_tbf_get_limit ( struct rtnl_qdisc *  qdisc  ) 

Parameters:
qdisc TBF qdisc.
Returns:
Limit in bytes or a negative error code.

Definition at line 297 of file tbf.c.

int rtnl_qdisc_tbf_set_mpu ( struct rtnl_qdisc *  qdisc,
int  mpu 
)

Parameters:
qdisc TBF qdisc to be modified.
mpu New MPU in bytes.
Returns:
0 on success or a negative error code.

Definition at line 314 of file tbf.c.

int rtnl_qdisc_tbf_get_mpu ( struct rtnl_qdisc *  qdisc  ) 

Parameters:
qdisc TBF qdisc.
Returns:
MPU in bytes or a negative error code.

Definition at line 333 of file tbf.c.

int rtnl_qdisc_tbf_set_rate ( struct rtnl_qdisc *  qdisc,
int  rate,
int  bucket,
int  cell 
)

Parameters:
qdisc TBF qdisc to be modified.
rate New rate in bytes per second.
bucket Size of bucket in bytes.
cell Size of a rate cell or 0 to get default value.
Returns:
0 on success or a negative error code.

Definition at line 369 of file tbf.c.

References rtnl_tc_calc_txtime().

int rtnl_qdisc_tbf_get_rate ( struct rtnl_qdisc *  qdisc  ) 

Parameters:
qdisc TBF qdisc.
Returns:
Rate in bytes per seconds or a negative error code.

Definition at line 397 of file tbf.c.

int rtnl_qdisc_tbf_get_rate_bucket ( struct rtnl_qdisc *  qdisc  ) 

Parameters:
qdisc TBF qdisc.
Returns:
Size of rate bucket or a negative error code.

Definition at line 413 of file tbf.c.

int rtnl_qdisc_tbf_get_rate_cell ( struct rtnl_qdisc *  qdisc  ) 

Parameters:
qdisc TBF qdisc.
Returns:
Size of rate cell in bytes or a negative error code.

Definition at line 429 of file tbf.c.

int rtnl_qdisc_tbf_set_peakrate ( struct rtnl_qdisc *  qdisc,
int  rate,
int  bucket,
int  cell 
)

Parameters:
qdisc TBF qdisc to be modified.
rate New peak rate in bytes per second.
bucket Size of peakrate bucket.
cell Size of a peakrate cell or 0 to get default value.
Returns:
0 on success or a negative error code.

Definition at line 448 of file tbf.c.

References rtnl_tc_calc_txtime().

int rtnl_qdisc_tbf_get_peakrate ( struct rtnl_qdisc *  qdisc  ) 

Parameters:
qdisc TBF qdisc.
Returns:
Peak rate in bytes per seconds or a negative error code.

Definition at line 477 of file tbf.c.

int rtnl_qdisc_tbf_get_peakrate_bucket ( struct rtnl_qdisc *  qdisc  ) 

Parameters:
qdisc TBF qdisc.
Returns:
Size of peak rate bucket or a negative error code.

Definition at line 493 of file tbf.c.

int rtnl_qdisc_tbf_get_peakrate_cell ( struct rtnl_qdisc *  qdisc  ) 

Parameters:
qdisc TBF qdisc.
Returns:
Size of peak rate cell in bytes or a negative error code.

Definition at line 509 of file tbf.c.

Generated on Tue Mar 4 23:48:33 2008 for libnl by  doxygen 1.5.5