Skip to content

Commit 66aac59

Browse files
committed
Document SubscriptionListener
References #38
1 parent fda603c commit 66aac59

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/docs/asciidoc/api.adoc

+6
Original file line numberDiff line numberDiff line change
@@ -784,6 +784,11 @@ The following table sums up the main settings to create a `Consumer`:
784784
|`ManualTrackingStrategy#checkInterval`
785785
|Interval to check if the last requested stored offset has been actually stored.
786786
|`Duration.ofSeconds(5)`
787+
788+
|subscriptionListener
789+
|A <<consumer-subscription-listener, callback>> before the subscription is created.
790+
Useful when using an external store for offset tracking.
791+
|`null`
787792
|===
788793

789794
[NOTE]
@@ -979,6 +984,7 @@ This means one must be careful when basing some decision on offset values, like
979984
a modulo to perform an operation every X messages. As the message offsets have
980985
no guarantee to be contiguous, the operation may not happen exactly every X messages.
981986

987+
[[consumer-subscription-listener]]
982988
====== Subscription Listener
983989

984990
The client provides a `SubscriptionListener` interface callback to add behavior before a subscription is created.

0 commit comments

Comments
 (0)