Skip to content

Commit ec609a5

Browse files
committed
Add comments to FDv2 data source interfaces.
1 parent 84be62d commit ec609a5

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

lib/sdk/server/src/main/java/com/launchdarkly/sdk/server/datasources/Initializer.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@
4646
public interface Initializer extends Closeable {
4747
/**
4848
* Run the initializer to completion.
49+
* <p>
50+
* This method is intended to be called only single time for an instance.
4951
* @return The result of the initializer.
5052
*/
5153
CompletableFuture<FDv2SourceResult> run();

lib/sdk/server/src/main/java/com/launchdarkly/sdk/server/datasources/Synchronizer.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ public interface Synchronizer extends Closeable {
5252
* <p>
5353
* This method is intended to be driven by a single thread, and for there to be a single outstanding call
5454
* at any given time.
55+
* <p>
56+
* Once SHUTDOWN, TERMINAL_ERROR, or GOODBYE has been produced, then no further calls to next() should be made.
5557
* @return a future that will complete when the next result is available
5658
*/
5759
CompletableFuture<FDv2SourceResult> next();

0 commit comments

Comments
 (0)