clientv3: document context to "KeepAlive" API #9023
Merged
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
xiang90
reviewed
Dec 15, 2017
clientv3/lease.go
Outdated
| // When the context "ctx" is canceled or timed out, | ||
| // returned "LeaseKeepAliveResponse" channel is closed, | ||
| // and "LeaseKeepAliveResponse" from this closed channel is nil. | ||
| // If the context is "context.Background/TODO", |
There was a problem hiding this comment.
probably wont say anything about the TODO one. line 116 already explains it. we might want to talk about when an error can be returned though.
xiang90
reviewed
Dec 16, 2017
clientv3/lease.go
Outdated
| @@ -114,6 +114,9 @@ type Lease interface { | |||
| Leases(ctx context.Context) (*LeaseLeasesResponse, error) | |||
|
|
|||
| // KeepAlive keeps the given lease alive forever. | |||
| // If the context "ctx" is canceled or timed out, | |||
| // returned "LeaseKeepAliveResponse" channel is closed, | |||
| // and "LeaseKeepAliveResponse" from this closed channel is nil. | |||
| KeepAlive(ctx context.Context, id LeaseID) (<-chan *LeaseKeepAliveResponse, error) | |||
There was a problem hiding this comment.
we should document about the error? for example, what happens if the client failed to send keepalive for a few minutes, and when it reconnected the lease is already expired?
Codecov Report
@@ Coverage Diff @@
## master #9023 +/- ##
=========================================
+ Coverage 76.12% 76.22% +0.1%
=========================================
Files 359 359
Lines 29838 29838
=========================================
+ Hits 22715 22745 +30
+ Misses 5548 5529 -19
+ Partials 1575 1564 -11
Continue to review full report at Codecov.
|
Signed-off-by: Gyuho Lee <gyuhox@gmail.com>
Signed-off-by: Gyuho Lee <gyuhox@gmail.com>
|
lgtm |
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.
Address #8993.