Skip to content

MINOR: Improve JavaDocs of KafkaStreams context.commit() #14163

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

Merged
mjsax merged 2 commits into from
Aug 8, 2023
Merged

MINOR: Improve JavaDocs of KafkaStreams context.commit() #14163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f3af19
MINOR: Improve JavaDocs of KafkaStreams `context.commit()`
mjsax Aug 7, 2023
0e6d454
fix
mjsax Aug 8, 2023
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
4 changes: 3 additions & 1 deletion streams/src/main/java/org/apache/kafka/streams/processor/api/ProcessingContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,9 @@ Cancellable schedule(final Duration interval,
final Punctuator callback);

/**
* Request a commit.
* Request a commit. Note that calling {@code commit()} is only a request for a commit, but it does not execute one.
* Hence, when {@code commit()} returns, no commit was executed yet. However, Kafka Streams will commit as soon
* as possible, instead of waiting for next {@code commit.interval.ms} to pass.
*/
void commit();

Expand Down
6 changes: 4 additions & 2 deletions ...est/java/org/apache/kafka/streams/processor/internals/assignment/AssignmentTestUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -805,12 +805,14 @@ static Map<Subtopology, Set<TaskId>> getTopologyGroupTaskMap() {
return Collections.singletonMap(SUBTOPOLOGY_0, Collections.singleton(new TaskId(1, 1)));
}

static void verifyStandbySatisfyRackReplica(final Set<TaskId> taskIds,
static void verifyStandbySatisfyRackReplica(
final Set<TaskId> taskIds,
Copy link
Member Author

@mjsax mjsax Aug 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated side cleanup to fix formatting

final Map<UUID, String> racksForProcess,
final Map<UUID, ClientState> clientStateMap,
final Integer replica,
final boolean relaxRackCheck,
final Map<UUID, Integer> standbyTaskCount) {
final Map<UUID, Integer> standbyTaskCount
) {
if (standbyTaskCount != null) {
for (final Entry<UUID, ClientState> entry : clientStateMap.entrySet()) {
final int expected = standbyTaskCount.get(entry.getKey());
Expand Down