Spring/spring-data-redis
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve StreamMessageListenerContainer Javadoc.

Browse Source 
Fix minor typos and improve the clarity of the StreamMessageListenerContainer Javadoc regarding subscription registration.

Closes #3021
This commit is contained in:
DongCheol Kim
2024-10-14 15:15:17 +09:00
committed by Mark Paluch
parent 18b43f27f6
commit e2746ecf5a
1 changed files with 17 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
src/main/java/org/springframework/data/redis/stream/StreamMessageListenerContainer.java
View File

@@ -106,6 +106,7 @@ import org.springframework.util.ErrorHandler;
* @author Mark Paluch
* @author Christoph Strobl
* @author Christian Rest
* @author DongCheol Kim
* @param <K> Stream key and Stream field type.
* @param <V> Stream value type.
* @since 2.2
@@ -155,9 +156,10 @@ public interface StreamMessageListenerContainer<K, V extends Record<K, ?>> exten
}
/**
* Register a new subscription for a Redis Stream. If the {@link StreamMessageListenerContainer#isRunning() is already
* running} the {@link Subscription} will be added and run immediately, otherwise it'll be scheduled and started once
* the container is actually {@link StreamMessageListenerContainer#start() started}.
* Register a new subscription for a Redis Stream. If a {@link StreamMessageListenerContainer} is already
* {@link StreamMessageListenerContainer#isRunning() running} the {@link Subscription} will be added and run
* immediately, otherwise it'll be scheduled and started once the container is actually
* {@link StreamMessageListenerContainer#start() started}.
* <p>
* Errors during {@link Record} retrieval lead to {@link Subscription#cancel() cancellation} of the underlying task.
* <p>
@@ -174,9 +176,10 @@ public interface StreamMessageListenerContainer<K, V extends Record<K, ?>> exten
}
/**
* Register a new subscription for a Redis Stream. If the {@link StreamMessageListenerContainer#isRunning() is already
* running} the {@link Subscription} will be added and run immediately, otherwise it'll be scheduled and started once
* the container is actually {@link StreamMessageListenerContainer#start() started}.
* Register a new subscription for a Redis Stream. If a {@link StreamMessageListenerContainer} is already
* {@link StreamMessageListenerContainer#isRunning() running} the {@link Subscription} will be added and run
* immediately, otherwise it'll be scheduled and started once the container is actually
* {@link StreamMessageListenerContainer#start() started}.
* <p>
* Every message must be acknowledged using
* {@link org.springframework.data.redis.core.StreamOperations#acknowledge(Object, String, String...)} after
@@ -200,9 +203,10 @@ public interface StreamMessageListenerContainer<K, V extends Record<K, ?>> exten
}
/**
* Register a new subscription for a Redis Stream. If the {@link StreamMessageListenerContainer#isRunning() is already
* running} the {@link Subscription} will be added and run immediately, otherwise it'll be scheduled and started once
* the container is actually {@link StreamMessageListenerContainer#start() started}.
* Register a new subscription for a Redis Stream. If a {@link StreamMessageListenerContainer} is already
* {@link StreamMessageListenerContainer#isRunning() running} the {@link Subscription} will be added and run
* immediately, otherwise it'll be scheduled and started once the container is actually
* {@link StreamMessageListenerContainer#start() started}.
* <p>
* Every message is acknowledged when received.
* <p>
@@ -223,9 +227,10 @@ public interface StreamMessageListenerContainer<K, V extends Record<K, ?>> exten
}
/**
* Register a new subscription for a Redis Stream. If the {@link StreamMessageListenerContainer#isRunning() is already
* running} the {@link Subscription} will be added and run immediately, otherwise it'll be scheduled and started once
* the container is actually {@link StreamMessageListenerContainer#start() started}.
* Register a new subscription for a Redis Stream. If a {@link StreamMessageListenerContainer} is already
* {@link StreamMessageListenerContainer#isRunning() running} the {@link Subscription} will be added and run
* immediately, otherwise it'll be scheduled and started once the container is actually
* {@link StreamMessageListenerContainer#start() started}.
* <p>
* Errors during {@link Record} are tested against test {@link StreamReadRequest#getCancelSubscriptionOnError()
* cancellation predicate} whether to cancel the underlying task.