File: leadership.go

package info (click to toggle)
golang-github-canonicalltd-raft-test 0.0~git20180628.c3345b5-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 284 kB
  • sloc: makefile: 2
file content (43 lines) | stat: -rw-r--r-- 1,304 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
// Copyright 2017 Canonical Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package election

import (
	"github.com/hashicorp/raft"
)

// Leadership represents the leadership acquired by a server that was elected
// as leader. It exposes methods to be notified about its loss, with the server
// stepping down as leader.
type Leadership struct {
	// ID of the raft server that acquired the leadership.
	id raft.ServerID

	// Notification about leadership being lost.
	lostCh chan struct{}
}

// Create new leadership object.
func newLeadership(id raft.ServerID, lostCh chan struct{}) *Leadership {
	return &Leadership{
		id:     id,
		lostCh: lostCh,
	}
}

// Lost returns a channel that gets closed when leadership is lost.
func (l *Leadership) Lost() chan struct{} {
	return l.lostCh
}