Add defer_rcu_ratelimit()

[urcu.git] / README

diff --git a/README b/README
index 7cc8871398b4c0a8b255bf8ddabfcbb7a40ed846..e1ce893737acd0d4d79260462f6383ff45a05c42 100644 (file)
--- a/README
+++ b/README
@@ -100,10 +100,13 @@ Usage of liburcu-defer
 
        * #include <urcu-defer.h>
        * Link with "-lurcu-defer"
-       * Provides call_rcu() primitive to enqueue delayed callbacks. Queued
+       * Provides defer_rcu() primitive to enqueue delayed callbacks. Queued
          callbacks are executed in batch periodically after a grace period.
-         Do _not_ use call_rcu() within a read-side critical section, because
+         Do _not_ use defer_rcu() within a read-side critical section, because
          it may call synchronize_rcu() if the thread queue is full.
+       * Provides defer_rcu_ratelimit() primitive, which acts just like
+         defer_rcu(), but takes an additional rate limiter callback forcing
+         synchronized callback execution of the limiter returns non-zero.
 
 Being careful with signals