Merge pull request #9024 from gyuho/snapshot-doc

clientv3: document context to "Snapshot" API
This commit is contained in:
Gyuho Lee
2017-12-21 12:44:40 -08:00
committed by GitHub
2 changed files with 4 additions and 0 deletions

View File

@@ -57,6 +57,8 @@ type Maintenance interface {
HashKV(ctx context.Context, endpoint string, rev int64) (*HashKVResponse, error)
// Snapshot provides a reader for a point-in-time snapshot of etcd.
// If the context "ctx" is canceled or timed out, reading from returned
// "io.ReadCloser" would error out (e.g. context.Canceled, context.DeadlineExceeded).
Snapshot(ctx context.Context) (io.ReadCloser, error)
// MoveLeader requests current leader to transfer its leadership to the transferee.