diff --git a/README.md b/README.md index 423d164..7f7e7cd 100644 --- a/README.md +++ b/README.md @@ -413,7 +413,7 @@ puts "Let's go" # will be called immediately after the lock is obtained #### #lock! - exceptional lock obtaining -[back_to_top](#usage) +\[[back to top](#usage)\] - fails when (and with): - (`RedisQueuedLocks::LockAlreadyObtainedError`) when `fail_fast` is `true` and lock is already obtained; @@ -445,7 +445,7 @@ See `#lock` method [documentation](#lock---obtain-a-lock). #### #lock_info -[back_to_top](#usage) +\[[back to top](#usage)\] - get the lock information; - returns `nil` if lock does not exist; @@ -492,7 +492,7 @@ rql.lock_info("your_lock_name") #### #queue_info -[back_to_top](#usage) +\[[back to top](#usage)\] Returns an information about the required lock queue by the lock name. The result represnts the ordered lock request queue that is ordered by score (Redis Sets) and shows @@ -531,7 +531,7 @@ rql.queue_info("your_lock_name") #### #locked? -[back_to_top](#usage) +\[[back to top](#usage)\] - is the lock obtaied or not? @@ -553,7 +553,7 @@ rql.queued?("your_lock_name") # => true/false #### #unlock - release a lock -[back_to_top](#usage) +\[[back to top](#usage)\] - release the concrete lock with lock request queue; - queue will be relased first; @@ -602,7 +602,7 @@ rql.unlock("your_lock_name") #### #clear_locks - release all locks and lock queues -[back_to_top](#usage) +\[[back to top](#usage)\] - release all obtained locks and related lock request queues; - queues will be released first; @@ -639,7 +639,7 @@ rql.clear_locks #### #extend_lock_ttl -[back_to_top](#usage) +\[[back to top](#usage)\] - extends lock ttl by the required number of milliseconds; - expects the lock name and the number of milliseconds; @@ -680,7 +680,7 @@ rql.extend_lock_ttl("my_lock", 5_000) # NOTE: add 5_000 milliseconds #### #locks - get list of obtained locks -[back_to_top](#usage) +\[[back to top](#usage)\] - uses redis `SCAN` under the hood; - accepts: @@ -712,7 +712,7 @@ rql.locks # or rql.locks(scan_size: 123) #### #queues - get list of lock request queues -[back_to_top](#usage) +\[[back to top](#usage)\] - uses redis `SCAN` under the hood; - accepts @@ -744,7 +744,7 @@ rql.queues # or rql.queues(scan_size: 123) #### #keys - get list of taken locks and queues -[back_to_top](#usage) +\[[back to top](#usage)\] - uses redis `SCAN` under the hood; - accepts: @@ -777,7 +777,7 @@ rql.keys # or rql.keys(scan_size: 123) #### #locks_info - get list of locks with their info -[back_to_top](#usage) +\[[back to top](#usage)\] - uses redis `SCAN` under the hod; - accepts `scan_size:`/`Integer` option (`config[:key_extraction_batch_size]` by default); @@ -811,7 +811,7 @@ rql.locks_info # or rql.locks_info(scan_size: 123) #### #queues_info - get list of queues with their info -[back_to_top](#usage) +\[[back to top](#usage)\] - uses redis `SCAN` under the hod; - accepts `scan_size:`/`Integer` option (`config[:key_extraction_batch_size]` by default); @@ -840,7 +840,7 @@ rql.queues_info # or rql.qeuues_info(scan_size: 123) #### #clear_dead_requests -[back_to_top](#usage) +\[[back to top](#usage)\] In some cases your lock requests may become "dead". It can happen when your processs that are enqueeud to the lock queue is failed unexpectedly (for some reason) before the lock acquire moment @@ -913,6 +913,8 @@ By default `RedisQueuedLocks::Client` is configured with the void notifier (whic ### Instrumentation Events +\[[back to top](#instrumentation-events)\] + List of instrumentation events - `redis_queued_locks.lock_obtained`