SolarCapture C Bindings User Guide  SF-115721-CD
Draft 2A
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
sc_token_bucket_shaper Node Reference

This node performs traffic shaping using the token bucket algorithm.

Detailed Description

This node performs traffic shaping using the token bucket algorithm. It can be used to limit packet rate (max_pps), or bandwidth (max_bps). It can also be used to limit a blend of packet rate and bandwidth by setting max_bps and overhead.

Arguments

Argument Optional? Default Type Description
max_pps Yes - SC_PARAM_DBL Maximum packet rate in packets-per-second.
max_bps Yes - SC_PARAM_DBL Maximum bandwidth in bits-per-second.
overhead Yes 0 SC_PARAM_INT Per packet overhead in bytes (used with max_bps).
show_config Yes 0 SC_PARAM_INT When this is set to 1 the configuration is written to stderr at startup.

Named Input Links

None

Output Links

Link Description
"" All packets are sent down this link.