chore: update the description for Pending() interface #84
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Keran Yang <[email protected]>
Signed-off-by: Keran Yang <[email protected]>
whynowy
reviewed
Oct 2, 2023
| // Read should never attempt to close the message channel as the caller owns the channel. | ||
| Read(ctx context.Context, readRequest ReadRequest, messageCh chan<- Message) | ||
| // Ack acknowledges the data from the source. | ||
| Ack(ctx context.Context, request AckRequest) | ||
| // Pending returns the number of pending messages. | ||
| // When the return value is negative, it indicates the pending information is not available. | ||
| // With pending information being not available, the Numaflow platform doesn't auto-scale the source. |
There was a problem hiding this comment.
What should be the returned value for being not available?
There was a problem hiding this comment.
Sorry the line above(L18) mentioned that if the returned value is negative, it indicate pending is not available
There was a problem hiding this comment.
oh.. missed that.
Shall we expose a constant for it?
There was a problem hiding this comment.
I don't have a strong opinion on this one. I think asking the user to return a random negative number is already quite straightforward.
whynowy
approved these changes
Oct 2, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.