Skip to content

Commit 59685f6

Browse files
committed
Mark SubscriptionListener as experimental
References #38
1 parent 24cfa94 commit 59685f6

File tree

3 files changed

+11
-1
lines changed

3 files changed

+11
-1
lines changed

src/docs/asciidoc/api.adoc

+7-1
Original file line numberDiff line numberDiff line change
@@ -899,9 +899,15 @@ no guarantee to be contiguous, the operation may not happen exactly every X mess
899899
====== Subscription Listener
900900

901901
The client provides a `SubscriptionListener` interface callback to add behavior before a subscription is created.
902-
This callback can be used to customize the offset the client computed for the subscription.
902+
This callback can be used to customize the offset the client library computed for the subscription.
903903
The callback is called when the consumer is first created and when the client has to re-subscribe (e.g. after a disconnection or a topology change).
904904

905+
[WARNING]
906+
.Experimental
907+
====
908+
This API is experimental, it is subject to change.
909+
====
910+
905911
It is possible to use the callback to get the last processed offset from an external store, that is not using the server-side offset tracking feature RabbitMQ Stream provides.
906912
The following code snippet shows how this can be done (note the interaction with the external store is not detailed):
907913

src/main/java/com/rabbitmq/stream/ConsumerBuilder.java

+2
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ public interface ConsumerBuilder {
6969
*
7070
* <p>Can be used to set the offset specification before subscribing to the stream.
7171
*
72+
* <p>This is an experimental API, subject to change.
73+
*
7274
* @see SubscriptionListener
7375
* @param subscriptionListener the listener
7476
* @return this builder instance

src/main/java/com/rabbitmq/stream/SubscriptionListener.java

+2
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
*
1919
* <p>It is possible to change the computed {@link OffsetSpecification} in {@link
2020
* #preSubscribe(SubscriptionContext)} by using a custom offset tracking strategy.
21+
*
22+
* <p>This is an experimental API, subject to change.
2123
*/
2224
public interface SubscriptionListener {
2325

0 commit comments

Comments
 (0)