Skip to content

Commit

Permalink
fix: comments for PauseAll and ResumeAll (#2523)
Browse files Browse the repository at this point in the history
Signed-off-by: napallday <bzx0619@gmail.com>
  • Loading branch information
napallday authored Jul 25, 2023
1 parent 63ff8d1 commit 669d2bc
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions consumer.go
Original file line number Diff line number Diff line change
Expand Up @@ -85,13 +85,13 @@ type Consumer interface {
// New calls to the broker will return records from these partitions if there are any to be fetched.
Resume(topicPartitions map[string][]int32)

// Pause suspends fetching from all partitions. Future calls to the broker will not return any
// PauseAll suspends fetching from all partitions. Future calls to the broker will not return any
// records from these partitions until they have been resumed using Resume()/ResumeAll().
// Note that this method does not affect partition subscription.
// In particular, it does not cause a group rebalance when automatic assignment is used.
PauseAll()

// Resume resumes all partitions which have been paused with Pause()/PauseAll().
// ResumeAll resumes all partitions which have been paused with Pause()/PauseAll().
// New calls to the broker will return records from these partitions if there are any to be fetched.
ResumeAll()
}
Expand Down

0 comments on commit 669d2bc

Please sign in to comment.