Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
auloin committed Oct 24, 2024
1 parent 5bb6fc3 commit 4c11a10
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
1 change: 1 addition & 0 deletions content/en/documentation/pro/mutexes.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ menu:

A `mutex` is a mutually exclusive flag. It acts as a gate keeper to a resource allowing only one `Job` to use it and postpones all others jobs using the same `mutex`.

> You cannot use both a mutex and a [rate limiter]({{< ref "/documentation/pro/rate-limiters" >}}) on the same `Job`.
## Usage via `@Job` annotation
Using a mutex is as easy as using Queues and Server Tags, again thanks to the `Job` annotation. Just add it to your service method and specify the mutex to use
Expand Down
3 changes: 3 additions & 0 deletions content/en/documentation/pro/rate-limiters.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ A `rate limiter` allows to control the execution rate of `Jobs` to avoid overwhe

You can configure different rate limiters to be used within your system and rate limiters can be shared by different job types, however each job can only use one `rate limiter`.

> When using a rate limiter there may be a latency of `pollIntervalInSeconds` before a rate-limited `Job` can start processing due an extra state change from `AWAITING` to `ENQUEUED`.<br>
> Please also note that you cannot use both a rate limiter and a [`mutex`]({{< ref "/documentation/pro/mutexes" >}}) on the same `Job`.
On this page you will learn how to:
- [configure a concurrent rate limiter](#concurrent-rate-limiters)
- [configure a sliding time window rate limiter](#sliding-time-window-rate-limiters)
Expand Down

0 comments on commit 4c11a10

Please sign in to comment.