github-forks
/
redisson
mirror of https://github.com/redisson/redisson.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs updated

Browse Source
pull/6272/head
Nikita Koksharov 3 months ago
parent 9cd1c7626b
commit f280727bd4
4 changed files with 104 additions and 104 deletions
Show Stats Download Patch File Download Diff File

4
docs/commands-mapping.md
Unescape Escape View File

@ -14,8 +14,8 @@ BLPOP|RBlockingQueue.<br/>take()<br/>poll()<br/>pollFromAny()<br/>takeAsync()<br
BLMOVE|RBlockingDeque.<br/>move()<br/>moveAsync()| RBlockingDequeReactive.<br/>move()|RBlockingDequeRx.<br/>move()|
BRPOP|RBlockingDeque.<br/>takeLast()<br/>takeLastAsync() | RBlockingDequeReactive.<br/>takeLast() | RBlockingDequeRx.<br/>takeLast() |
BRPOPLPUSH|RBlockingQueue.<br/>pollLastAndOfferFirstTo()<br/>pollLastAndOfferFirstToAsync() | RBlockingQueueReactive.<br/>pollLastAndOfferFirstTo()| RBlockingQueueRx.<br/>pollLastAndOfferFirstTo()|
CONFIG GET|RedisNode.<br/>setConfig()<br/>setConfigAsync() | - | - |
CONFIG SET|RedisNode.<br/>getConfig()<br/>getConfigAsync() | - | - |
CONFIG GET|RedisNode.<br/>getConfig()<br/>getConfigAsync() | - | - |
CONFIG SET|RedisNode.<br/>setConfig()<br/>setConfigAsync() | - | - |
COPY|RObject.<br/>copy()<br/>copyAsync() | RObjectReactive.<br/>copy() | RObjectRx.<br/>copy() |
CLIENT SETNAME|Config.setClientName() | - | - |
CLIENT REPLY|BatchOptions.skipResult() | - | - |

164
docs/data-and-services/collections.md
Unescape Escape View File

@ -463,17 +463,17 @@ Usage of `RLocalCachedMap` and `RLocalCachedMapCache` objects boost Redis or Val
### Listeners
Redisson allows to bind listeners per `RMap` object.
Redisson allows binding listeners per `RMap` object. This requires the `notify-keyspace-events` setting to be enabled on Redis or Valkey side.
`RMap` object allows to track follow events over the data.
|Listener class name|Event description |
|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Entry created/removed/updated after read operation|
|org.redisson.api.listener.MapPutListener|Entry created/updated|
|org.redisson.api.listener.MapRemoveListener|Entry removed|
|org.redisson.api.ExpiredObjectListener|`RMap` object expired|
|org.redisson.api.DeletedObjectListener|`RMap` object deleted|
|Listener class name|Event description | Redis or Valkey<br/>`notify-keyspace-events` value|
|:--:|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Entry created/removed/updated after read operation| - |
|org.redisson.api.listener.MapPutListener|Entry created/updated|Eh|
|org.redisson.api.listener.MapRemoveListener|Entry removed|Eh|
|org.redisson.api.ExpiredObjectListener|`RMap` object expired|Ex|
|org.redisson.api.DeletedObjectListener|`RMap` object deleted|Eg|
Usage examples:
```java
@ -1013,16 +1013,16 @@ Below is the list of all available Set implementations:
### Listeners
Redisson allows to bind listeners per `RSet` object.
Redisson allows binding listeners per `RSet` object. This requires the `notify-keyspace-events` setting to be enabled on Redis or Valkey side.
|Listener class name|Event description |
|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Element added/removed/updated after read operation|
|org.redisson.api.ExpiredObjectListener|`RSet` object expired|
|org.redisson.api.DeletedObjectListener|`RSet` object deleted|
|org.redisson.api.listener.SetAddListener|Element added|
|org.redisson.api.listener.SetRemoveListener|Element removed|
|org.redisson.api.listener.SetRemoveRandomListener|Element randomly removed|
|Listener class name|Event description | Valkey or Redis<br/>`notify-keyspace-events` value|
|:--:|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Element added/removed/updated after read operation| -|
|org.redisson.api.ExpiredObjectListener|`RSet` object expired| Ex|
|org.redisson.api.DeletedObjectListener|`RSet` object deleted| Eg|
|org.redisson.api.listener.SetAddListener|Element added| Es|
|org.redisson.api.listener.SetRemoveListener|Element removed| Es|
|org.redisson.api.listener.SetRemoveRandomListener|Element randomly removed|Es|
Usage example:
@ -1096,15 +1096,15 @@ ScoredEntry<String> e = set.pollFirstEntry();
### Listeners
Redisson allows to bind listeners per `RScoredSortedSet` object.
Redisson allows binding listeners per `RScoredSortedSet` object. This requires the `notify-keyspace-events` setting to be enabled on Redis or Valkey side.
|Listener class name|Event description |
|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Element created/removed/updated after read operation|
|org.redisson.api.listener.ScoredSortedSetAddListener|Element created/updated|
|org.redisson.api.listener.ScoredSortedSetRemoveListener|Element removed|
|org.redisson.api.ExpiredObjectListener|`RScoredSortedSet` object expired|
|org.redisson.api.DeletedObjectListener|`RScoredSortedSet` object deleted|
|Listener class name|Event description | Valkey or Redis<br/>`notify-keyspace-events` value|
|:--:|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Element created/removed/updated after read operation| - |
|org.redisson.api.listener.ScoredSortedSetAddListener|Element created/updated|Ez|
|org.redisson.api.listener.ScoredSortedSetRemoveListener|Element removed|Ez|
|org.redisson.api.ExpiredObjectListener|`RScoredSortedSet` object expired|Ex|
|org.redisson.api.DeletedObjectListener|`RScoredSortedSet` object deleted|Eg|
Usage example:
@ -1140,15 +1140,15 @@ set.range("d", true, "z", false);
### Listeners
Redisson allows to bind listeners per `RLexSortedSet` object.
Redisson allows binding listeners per `RLexSortedSet` object. This requires the `notify-keyspace-events` setting to be enabled on Redis or Valkey side.
|Listener class name|Event description |
|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Element created/removed/updated after read operation|
|org.redisson.api.listener.ScoredSortedSetAddListener|Element created/updated|
|org.redisson.api.listener.ScoredSortedSetRemoveListener|Element removed|
|org.redisson.api.ExpiredObjectListener|`RScoredSortedSet` object expired|
|org.redisson.api.DeletedObjectListener|`RScoredSortedSet` object deleted|
|Listener class name|Event description | Valkey or Redis<br/>`notify-keyspace-events` value|
|:--:|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Element created/removed/updated after read operation|-|
|org.redisson.api.listener.ScoredSortedSetAddListener|Element created/updated|Ez|
|org.redisson.api.listener.ScoredSortedSetRemoveListener|Element removed|Ez|
|org.redisson.api.ExpiredObjectListener|`RScoredSortedSet` object expired|Ex|
|org.redisson.api.DeletedObjectListener|`RScoredSortedSet` object deleted|Eg|
Usage example:
@ -1180,18 +1180,18 @@ list.remove(new SomeObject());
### Listeners
Redisson allows to bind listeners per `RList` object.
Redisson allows binding listeners per `RList` object. This requires the `notify-keyspace-events` setting to be enabled on Redis or Valkey side.
|Listener class name|Event description |
|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Element created/removed/updated after read operation|
|org.redisson.api.listener.ListAddListener|Element created|
|org.redisson.api.listener.ListInsertListener|Element inserted|
|org.redisson.api.listener.ListSetListener|Element set/updated|
|org.redisson.api.listener.ListRemoveListener|Element removed|
|org.redisson.api.listener.ListTrimListener|List trimmed|
|org.redisson.api.ExpiredObjectListener|`RList` object expired|
|org.redisson.api.DeletedObjectListener|`RList` object deleted|
|Listener class name|Event description | Valkey or Redis<br/>`notify-keyspace-events` value|
|:--:|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Element created/removed/updated after read operation|-|
|org.redisson.api.listener.ListAddListener|Element created|El|
|org.redisson.api.listener.ListInsertListener|Element inserted|El|
|org.redisson.api.listener.ListSetListener|Element set/updated|El|
|org.redisson.api.listener.ListRemoveListener|Element removed|El|
|org.redisson.api.listener.ListTrimListener|List trimmed|El|
|org.redisson.api.ExpiredObjectListener|`RList` object expired|Ex|
|org.redisson.api.DeletedObjectListener|`RList` object deleted|Eg|
Usage example:
@ -1225,15 +1225,15 @@ SomeObject someObj = queue.poll();
### Listeners
Redisson allows to bind listeners per `RQueue` object.
Redisson allows binding listeners per `RQueue` object. This requires the `notify-keyspace-events` setting to be enabled on Redis or Valkey side.
|Listener class name|Event description |
|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Element created/removed/updated after read operation|
|org.redisson.api.listener.ListAddListener|Element created|
|org.redisson.api.listener.ListRemoveListener|Element removed|
|org.redisson.api.ExpiredObjectListener|`RQueue` object expired|
|org.redisson.api.DeletedObjectListener|`RQueue` object deleted|
|Listener class name|Event description | Valkey or Redis<br/>`notify-keyspace-events` value|
|:--:|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Element created/removed/updated after read operation|-|
|org.redisson.api.listener.ListAddListener|Element created|El|
|org.redisson.api.listener.ListRemoveListener|Element removed|El|
|org.redisson.api.ExpiredObjectListener|`RQueue` object expired|Ex|
|org.redisson.api.DeletedObjectListener|`RQueue` object deleted|Eg|
Usage example:
@ -1266,15 +1266,15 @@ SomeObject someObj = queue.removeLast();
### Listeners
Redisson allows to bind listeners per `RDeque` object.
Redisson allows binding listeners per `RDeque` object. This requires the `notify-keyspace-events` setting to be enabled on Redis or Valkey side.
|Listener class name|Event description |
|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Element created/removed/updated after read operation|
|org.redisson.api.listener.ListAddListener|Element created|
|org.redisson.api.listener.ListRemoveListener|Element removed|
|org.redisson.api.ExpiredObjectListener|`RDeque` object expired|
|org.redisson.api.DeletedObjectListener|`RDeque` object deleted|
|Listener class name|Event description | Valkey or Redis<br/>`notify-keyspace-events` value|
|:--:|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Element created/removed/updated after read operation|-|
|org.redisson.api.listener.ListAddListener|Element created|El|
|org.redisson.api.listener.ListRemoveListener|Element removed|El|
|org.redisson.api.ExpiredObjectListener|`RDeque` object expired|Ex|
|org.redisson.api.DeletedObjectListener|`RDeque` object deleted|Eg|
Usage example:
@ -1631,20 +1631,20 @@ amountRx.doOnSuccess(res -> {
### Listeners
Redisson allows to bind listeners per `RStream` object.
|Listener class name|Event description |
|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Element added/removed/updated after read operation|
|org.redisson.api.ExpiredObjectListener|`RStream` object expired|
|org.redisson.api.DeletedObjectListener|`RStream` object deleted|
|org.redisson.api.listener.StreamAddListener|Element added|
|org.redisson.api.listener.StreamRemoveListener|Element removed|
|org.redisson.api.listener.StreamCreateGroupListener|Group created|
|org.redisson.api.listener.StreamRemoveGroupListener|Group removed|
|org.redisson.api.listener.StreamCreateConsumerListener|Consumer created|
|org.redisson.api.listener.StreamRemoveConsumerListener|Consumer removed|
|org.redisson.api.listener.StreamTrimListener|Stream trimmed|
Redisson allows binding listeners per `RStream` object. This requires the `notify-keyspace-events` setting to be enabled on Redis or Valkey side.
|Listener class name|Event description | Valkey or Redis<br/>`notify-keyspace-events` value|
|:--:|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Element added/removed/updated after read operation|-|
|org.redisson.api.ExpiredObjectListener|`RStream` object expired|Ex|
|org.redisson.api.DeletedObjectListener|`RStream` object deleted|Eg|
|org.redisson.api.listener.StreamAddListener|Element added|Et|
|org.redisson.api.listener.StreamRemoveListener|Element removed|Et|
|org.redisson.api.listener.StreamCreateGroupListener|Group created|Et|
|org.redisson.api.listener.StreamRemoveGroupListener|Group removed|Et|
|org.redisson.api.listener.StreamCreateConsumerListener|Consumer created|Et|
|org.redisson.api.listener.StreamRemoveConsumerListener|Consumer removed|Et|
|org.redisson.api.listener.StreamTrimListener|Stream trimmed|Et|
Usage example:
@ -1777,15 +1777,15 @@ addRx.doOnSuccess(res -> {
### Listeners
Redisson allows to bind listeners per `RRingBuffer` object.
Redisson allows binding listeners per `RRingBuffer` object. This requires the `notify-keyspace-events` setting to be enabled on Redis or Valkey side.
|Listener class name|Event description |
|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Element created/removed/updated after read operation|
|org.redisson.api.listener.ListAddListener|Element created|
|org.redisson.api.listener.ListRemoveListener|Element removed|
|org.redisson.api.ExpiredObjectListener|`RRingBuffer` object expired|
|org.redisson.api.DeletedObjectListener|`RRingBuffer` object deleted|
|Listener class name|Event description | Valkey or Redis<br/>`notify-keyspace-events` value|
|:--:|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Element created/removed/updated after read operation|-|
|org.redisson.api.listener.ListAddListener|Element created|El|
|org.redisson.api.listener.ListRemoveListener|Element removed|El|
|org.redisson.api.ExpiredObjectListener|`RRingBuffer` object expired|Ex|
|org.redisson.api.DeletedObjectListener|`RRingBuffer` object deleted|Eg|
Usage example:

28
docs/data-and-services/objects.md
Unescape Escape View File

@ -127,14 +127,14 @@ Completable sRx = buckets.set(map);
### Listeners
Redisson allows to bind listeners per `RBucket` object.
Redisson allows binding listeners per `RBucket` object. This requires the `notify-keyspace-events` setting to be enabled on Redis or Valkey side.
|Listener class name|Event description |
|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Data created/updated after read operation|
|org.redisson.api.listener.SetObjectListener|Data created/updated|
|org.redisson.api.ExpiredObjectListener|`RBucket` object expired|
|org.redisson.api.DeletedObjectListener|`RBucket` object deleted|
|Listener class name|Event description |Redis or Valkey<br/>`notify-keyspace-events` value|
|:--:|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Data created/updated after read operation| - |
|org.redisson.api.listener.SetObjectListener|Data created/updated|E$|
|org.redisson.api.ExpiredObjectListener|`RBucket` object expired|Ex|
|org.redisson.api.DeletedObjectListener|`RBucket` object deleted|Ex|
Usage example:
@ -261,14 +261,14 @@ sbc.write(contentToWrite);
### Listeners
Redisson allows to bind listeners per `RBinaryStream` object.
Redisson allows binding listeners per `RBinaryStream` object. This requires the `notify-keyspace-events` setting to be enabled on Redis or Valkey side.
|Listener class name|Event description |
|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Data created/updated after read operation|
|org.redisson.api.listener.SetObjectListener|Data created/updated|
|org.redisson.api.ExpiredObjectListener|`RBinaryStream` object expired|
|org.redisson.api.DeletedObjectListener|`RBinaryStream` object deleted|
|Listener class name|Event description |Redis or Valkey<br/>`notify-keyspace-events` value|
|:--:|:--:|:--:|
|org.redisson.api.listener.TrackingListener|Data created/updated after read operation|-|
|org.redisson.api.listener.SetObjectListener|Data created/updated|E$|
|org.redisson.api.ExpiredObjectListener|`RBinaryStream` object expired|Ex|
|org.redisson.api.DeletedObjectListener|`RBinaryStream` object deleted|Ex|
Usage example:

12
docs/web-session-management.md
Unescape Escape View File

@ -68,17 +68,17 @@ Amount of Redisson instances created by Tomcat for multiple contexts could be re
**2. Copy two jars into `TOMCAT_BASE/lib` directory:**
[redisson-all-3.37.0.jar](https://repo1.maven.org/maven2/org/redisson/redisson-all/3.37.0/redisson-all-3.37.0.jar)
[redisson-all-3.38.1.jar](https://repo1.maven.org/maven2/org/redisson/redisson-all/3.38.1/redisson-all-3.38.1.jar)
Tomcat 7.x - [redisson-tomcat-7-3.37.0.jar](https://repo1.maven.org/maven2/org/redisson/redisson-tomcat-7/3.37.0/redisson-tomcat-7-3.37.0.jar)
Tomcat 7.x - [redisson-tomcat-7-3.38.1.jar](https://repo1.maven.org/maven2/org/redisson/redisson-tomcat-7/3.38.1/redisson-tomcat-7-3.38.1.jar)
Tomcat 8.x - [redisson-tomcat-8-3.37.0.jar](https://repo1.maven.org/maven2/org/redisson/redisson-tomcat-8/3.37.0/redisson-tomcat-8-3.37.0.jar)
Tomcat 8.x - [redisson-tomcat-8-3.38.1.jar](https://repo1.maven.org/maven2/org/redisson/redisson-tomcat-8/3.38.1/redisson-tomcat-8-3.38.1.jar)
Tomcat 9.x - [redisson-tomcat-9-3.37.0.jar](https://repo1.maven.org/maven2/org/redisson/redisson-tomcat-9/3.37.0/redisson-tomcat-9-3.37.0.jar)
Tomcat 9.x - [redisson-tomcat-9-3.38.1.jar](https://repo1.maven.org/maven2/org/redisson/redisson-tomcat-9/3.38.1/redisson-tomcat-9-3.38.1.jar)
Tomcat 10.x - [redisson-tomcat-10-3.37.0.jar](https://repo1.maven.org/maven2/org/redisson/redisson-tomcat-10/3.37.0/redisson-tomcat-10-3.37.0.jar)
Tomcat 10.x - [redisson-tomcat-10-3.38.1.jar](https://repo1.maven.org/maven2/org/redisson/redisson-tomcat-10/3.38.1/redisson-tomcat-10-3.38.1.jar)
Tomcat 11.x - [redisson-tomcat-11-3.3x.0.jar](https://repo1.maven.org/maven2/org/redisson/redisson-tomcat-11/3.3x.0/redisson-tomcat-11-3.3x.0.jar)
Tomcat 11.x - [redisson-tomcat-11-3.38.1.jar](https://repo1.maven.org/maven2/org/redisson/redisson-tomcat-11/3.38.1/redisson-tomcat-11-3.38.1.jar)
Upgrade to __[Redisson PRO](https://redisson.pro)__ with **advanced features**.

Write Preview
Loading…
Cancel
Save