-
Notifications
You must be signed in to change notification settings - Fork 2
/
sync.go
101 lines (88 loc) · 2.92 KB
/
sync.go
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
// MIT License
//
// Copyright (c) 2020 The vine Authors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
// Package sync is an interface for distributed synchronization
package sync
import (
"context"
"errors"
"github.com/spf13/pflag"
)
var (
ErrLockTimeout = errors.New("lock timeout")
Flag = pflag.NewFlagSet("sync", pflag.ExitOnError)
)
func init() {
Flag.String("sync-default", "", "Sync for vine")
}
type Role string
const (
Primary Role = "primary"
Follow Role = "follow"
)
// Sync is an interface for distributed synchronization
type Sync interface {
// Init Initialise options
Init(...Option) error
// Options Return the options
Options() Options
// Leader Elect a leader
Leader(ctx context.Context, name string, opts ...LeaderOption) (Leader, error)
// ListMembers get all election member
ListMembers(ctx context.Context, opts ...ListMembersOption) ([]*Member, error)
// WatchElect watch leader event
WatchElect(ctx context.Context, opts ...WatchElectOption) (ElectWatcher, error)
// Lock acquires a lock
Lock(ctx context.Context, id string, opts ...LockOption) error
// Unlock releases a lock
Unlock(ctx context.Context, id string) error
// String Sync implementation
String() string
}
type Member struct {
Leader string `json:"leader"`
Id string `json:"id"`
Namespace string `json:"namespace"`
Role Role `json:"role"`
}
type ObserveResult struct {
Namespace string `json:"namespace"`
Id string `json:"id"`
}
// Leader provides leadership election
type Leader interface {
// Id leader node
Id() string
// Resign resigns leadership
Resign() error
// Observe watch leadership event
Observe() chan ObserveResult
// Primary get the info of primary role
Primary() (*Member, error)
// Status returns when leadership is lost
Status() chan bool
}
// ElectWatcher watch election event
type ElectWatcher interface {
// Next is a blocking call
Next() (*Member, error)
Close()
}