Mirroristas/etcd
2
0
Fork 0
mirror of https://github.com/etcd-io/etcd.git synced 2024-09-27 06:25:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9999 from vimalk78/9377_document_election_api

Browse Source 
clientv3/concurrency: Document Election API context parameter
This commit is contained in:
Gyuho Lee 2018-09-13 10:47:23 -07:00 committed by GitHub
commit 001bbb97cc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
clientv3/concurrency/election.go
View File

@ -55,8 +55,16 @@ func ResumeElection(s *Session, pfx string, leaderKey string, leaderRev int64) *
} }
} }
// Campaign puts a value as eligible for the election. It blocks until // Campaign puts a value as eligible for the election on the prefix
// it is elected, an error occurs, or the context is cancelled. // key.
// Multiple sessions can participate in the election for the
// same prefix, but only one can be the leader at a time.
//
// If the context is 'context.TODO()/context.Background()', the Campaign
// will continue to be blocked for other keys to be deleted, unless server
// returns a non-recoverable error (e.g. ErrCompacted).
// Otherwise, until the context is not cancelled or timed-out, Campaign will
// continue to be blocked until it becomes the leader.
func (e *Election) Campaign(ctx context.Context, val string) error { func (e *Election) Campaign(ctx context.Context, val string) error {
s := e.session s := e.session
client := e.session.Client() client := e.session.Client()