Skip to content

Improve StreamMessageListenerContainer Javadoc #3021

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Improve StreamMessageListenerContainer Javadoc #3021

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 17 additions & 12 deletions src/main/java/org/springframework/data/redis/stream/StreamMessageListenerContainer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@
* @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
Expand Down Expand Up @@ -155,9 +156,10 @@ static StreamMessageListenerContainer<String, MapRecord<String, String, String>>
}

/**
* 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>
Expand All @@ -174,9 +176,10 @@ default Subscription receive(StreamOffset<K> streamOffset, StreamListener<K, V>
}

/**
* 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
Expand All @@ -200,9 +203,10 @@ default Subscription receive(Consumer consumer, StreamOffset<K> streamOffset, St
}

/**
* 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>
Expand All @@ -223,9 +227,10 @@ default Subscription receiveAutoAck(Consumer consumer, StreamOffset<K> streamOff
}

/**
* 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.
Expand Down