Skip to content

Commit

Permalink
clientv3: document context to "KeepAlive" API
Browse files Browse the repository at this point in the history
Signed-off-by: Gyuho Lee <gyuhox@gmail.com>
  • Loading branch information
gyuho committed Dec 15, 2017
1 parent 940dace commit 8c2d75f
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions clientv3/lease.go
Original file line number Diff line number Diff line change
Expand Up @@ -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)

// KeepAliveOnce renews the lease once. In most of the cases, KeepAlive
Expand Down

0 comments on commit 8c2d75f

Please sign in to comment.