docs updated

pull/6367/head
Nikita Koksharov 1 month ago
parent 35e21c7c47
commit 88f4f09349

@ -193,7 +193,7 @@ public static class Application {
LocalCachedMapOptions options = LocalCachedMapOptions.defaults()
.evictionPolicy(EvictionPolicy.LFU)
.timeToLive(48, TimeUnit.MINUTES)
.maxIdle(24, TimeUnit.MINUTES);
.maxIdle(24, TimeUnit.MINUTES)
.cacheSize(1000);
// create "testMap" Redis or Valkey cache with ttl = 24 minutes and maxIdleTime = 12 minutes

@ -1,5 +1,5 @@
## Topic
Java implementation of Redis or Valkey based [RTopic](https://static.javadoc.io/org.redisson/redisson/latest/org/redisson/api/RTopic.html) object implements Publish / Subscribe mechanism. It allows to subscribe on events published with multiple instances of `RTopic` object with the same name.
Java [RTopic](https://static.javadoc.io/org.redisson/redisson/latest/org/redisson/api/RTopic.html) object implements Publish / Subscribe mechanism based on [Redis Pub/Sub](https://redis.io/docs/latest/develop/interact/pubsub/) or [Valkey Pub/Sub](https://valkey.io/topics/pubsub/). It allows to subscribe on events published with multiple instances of `RTopic` object with the same name.
Listeners are re-subscribed automatically after reconnection or failover. All messages sent during absence of connection are lost. Use [Reliable Topic](#reliable-topic) for reliable delivery.
@ -164,7 +164,7 @@ Single<Integer> listenerSingle = patternTopic.addListener(Message.class, new Pat
```
## Sharded topic
Java implementation of Redis or Valkey based [RShardedTopic](https://static.javadoc.io/org.redisson/redisson/latest/org/redisson/api/RShardedTopic.html) object implements Sharded Publish / Subscribe mechanism. It allows to subscribe on events published with multiple instances of `RShardedTopic` object with the same name. Subscribe/publish operations are executed only on Redis or Valkey node in Cluster which is bounded to specific topic name. Published messages via `RShardedTopic` aren't broadcasted across all nodes as for `RTopic` object. Which reduces network bandwidth and Redis or Valkey load.
Java implementation of Redis or Valkey based [RShardedTopic](https://static.javadoc.io/org.redisson/redisson/latest/org/redisson/api/RShardedTopic.html) object implements Sharded Publish / Subscribe mechanism. It allows to subscribe on events published with multiple instances of `RShardedTopic` object with the same name. Subscribe/publish operations are executed only on Redis or Valkey node in Cluster which is bounded to specific topic name. Published messages via `RShardedTopic` aren't broadcasted across all nodes as for `RTopic` object. Which reduces network bandwidth usage between Redis and Valkey nodes and their CPU load, as well as their CPU load.
Listeners are re-subscribed automatically after reconnection to a server or failover. All messages sent during absence of connection are lost. Use [Reliable Topic](#reliable-topic) for reliable delivery.
@ -238,7 +238,7 @@ Although each ShardedTopic instance is cluster-compatible, it can be connected o
* CPU overload on a single node.
* Overload of network or data traffic to a single node.
* Interruptions during failover.
* Full interruption of the message flow during failover.
ShardedTopic partitioning addresses these challenges by enabling connections to all nodes in cluster and distributing messages effectively. It brings the following benefits:
@ -350,7 +350,7 @@ Although each ReliableTopic instance is cluster-compatible, it can be connected
* CPU overload on a single node.
* Overload of network or data traffic to a single node.
* Interruptions during failover.
* Full interruption of the message flow during failover.
ReliableTopic partitioning addresses these challenges by enabling connections to all nodes in cluster and distributing messages effectively. It brings the following benefits:

@ -2,7 +2,7 @@
Integrates Redisson with Spring Boot library. Depends on [Spring Data Redis](#spring-data-redis) module.
Supports Spring Boot 1.3.x - 3.3.x
Supports Spring Boot 1.3.x - 3.4.x
### Usage
@ -38,7 +38,7 @@ For Gradle, you can downgrade to `redisson-spring-data-27` this way:
```groovy
implementation ("org.redisson:redisson-spring-boot-starter:xVERSIONx") {
exclude group: 'org.redisson', module: 'redisson-spring-data-33'
exclude group: 'org.redisson', module: 'redisson-spring-data-34'
}
implementation "org.redisson:redisson-spring-data-27:xVERSIONx"
```
@ -234,12 +234,12 @@ Ensure you have Spring Session library in your classpath, add it if necessary:
<dependency>
<groupId>org.springframework.session</groupId>
<artifactId>spring-session-core</artifactId>
<version>3.2.1</version>
<version>3.4.1</version>
</dependency>
<dependency>
<groupId>org.redisson</groupId>
<artifactId>redisson-spring-data-33</artifactId>
<artifactId>redisson-spring-data-34</artifactId>
<version>xVERSIONx</version>
</dependency>
```
@ -247,9 +247,9 @@ Ensure you have Spring Session library in your classpath, add it if necessary:
**Gradle**
```gradle
compile 'org.springframework.session:spring-session-core:3.2.1'
compile 'org.springframework.session:spring-session-core:3.4.1'
compile 'org.redisson:redisson-spring-data-33:xVERSIONx'
compile 'org.redisson:redisson-spring-data-34:xVERSIONx'
```
### Spring Http Session configuration
@ -308,20 +308,20 @@ Maven:
```
Gradle:
```gradle
compile 'org.springframework.session:spring-session-data-redis:3.2.1'
compile 'org.springframework.session:spring-session-data-redis:3.4.1'
```
2. Add Redisson Spring Data Redis library in classpath:
Maven:
```xml
<dependency>
<groupId>org.redisson</groupId>
<artifactId>redisson-spring-data-33</artifactId>
<artifactId>redisson-spring-data-34</artifactId>
<version>xVERSIONx</version>
</dependency>
```
Gradle:
```gradle
compile 'org.redisson:redisson-spring-data-33:xVERSIONx'
compile 'org.redisson:redisson-spring-data-34:xVERSIONx'
```
3. Define follow properties in spring-boot settings
```
@ -528,6 +528,8 @@ Maven:
<artifactId>redisson-spring-data-32</artifactId>
<!-- for Spring Data Redis v.3.3.x -->
<artifactId>redisson-spring-data-33</artifactId>
<!-- for Spring Data Redis v.3.4.x -->
<artifactId>redisson-spring-data-34</artifactId>
<version>xVERSIONx</version>
</dependency>
```
@ -563,6 +565,8 @@ compile 'org.redisson:redisson-spring-data-31:xVERSIONx'
compile 'org.redisson:redisson-spring-data-32:xVERSIONx'
// for Spring Data Redis v.3.3.x
compile 'org.redisson:redisson-spring-data-33:xVERSIONx'
// for Spring Data Redis v.3.4.x
compile 'org.redisson:redisson-spring-data-34:xVERSIONx'
```
2. Register `RedissonConnectionFactory` in Spring context:
```java

Loading…
Cancel
Save