Skip to content

Commit e9afed0

Browse files
committed
docs: fix some comments
1 parent 66e3936 commit e9afed0

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

libs/server-sdk/src/data_systems/fdv2/polling_initializer.hpp

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,11 @@ namespace launchdarkly::server_side::data_systems {
1919
/**
2020
* FDv2 polling initializer. Makes a single HTTP GET to the FDv2 polling
2121
* endpoint, parses the response via the FDv2 protocol state machine, and
22-
* returns the result. Implements IFDv2Initializer (async, one-shot).
22+
* returns the result.
2323
*
2424
* Threading model:
25-
* Run() is called once from the orchestrator thread. It fires the HTTP
26-
* request and returns a Future that resolves when the response arrives
27-
* or Close() is called.
28-
* Close() may be called from any thread, concurrently with Run().
25+
* Run() should only be called once at a time.
26+
* Close() may be called concurrently with Run().
2927
* This object may be safely destroyed once no call to Run() or Close()
3028
* is in progress.
3129
*/

libs/server-sdk/src/data_systems/fdv2/polling_synchronizer.hpp

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,10 @@ namespace launchdarkly::server_side::data_systems {
2323
* orchestrator to reflect applied changesets without any shared state.
2424
*
2525
* Threading model:
26-
* Next() may be called from any thread. Close() may be called from any
27-
* thread, concurrently with Next().
26+
* Next() should only be called once at a time.
27+
* Close() may be called concurrently with Next().
28+
* This object may be safely destroyed once no call to Next() or Close()
29+
* is in progress.
2830
*/
2931
class FDv2PollingSynchronizer final
3032
: public data_interfaces::IFDv2Synchronizer {

0 commit comments

Comments
 (0)