Commit e009d0e1 authored by Christian Sponfeldner's avatar Christian Sponfeldner

refactoring: Add more explenations in comments

parent 1a2a1c18
......@@ -11,6 +11,12 @@
* For multi-threading systems is a interface for boost mutex provided.
* You can define the weighting of a success and a fail (timeout) event.
* It is also possible to define the threshold for the return of an error.
*
* The leaky bucket shall indicate repeated timeouts.
* A timeout is defined by the given duration and evaluated with the callback function pointer get_time.
* When calling setEvent() the timeout timer gets reseted and the amount of error points inside the leaky bucket is decreased by value success_emphasis (except amount is already zero or lower).
* Any time update() is called and a timeout occurred since the last call of setEvent() an amount of error points in the leaky bucket is increased by value error_emphasis (except amount is already equal or bigger then error_threshold).
* If the amount of "error points" is equal or bigger or then error_threshold, the return value of checkError() is true.
*/
#ifndef ROS_PACKAGES_SEPP_SEPP_COMMON_CODE_INCLUDE_LEAKY_BUCKET_TIMEOUT_HPP_
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment