forked from cockroachdb/cockroach
-
Notifications
You must be signed in to change notification settings - Fork 0
/
int.go
103 lines (89 loc) · 2.59 KB
/
int.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
102
103
// Copyright 2017 The Cockroach Authors.
//
// 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 settings
import (
"sync/atomic"
"github.com/pkg/errors"
)
// IntSetting is the interface of a setting variable that will be
// updated automatically when the corresponding cluster-wide setting
// of type "int" is updated.
type IntSetting struct {
defaultValue int64
v int64
validateFn func(int64) error
}
var _ Setting = &IntSetting{}
// Get retrieves the int value in the setting.
func (i *IntSetting) Get() int64 {
return atomic.LoadInt64(&i.v)
}
func (i *IntSetting) String() string {
return EncodeInt(i.Get())
}
// Typ returns the short (1 char) string denoting the type of setting.
func (*IntSetting) Typ() string {
return "i"
}
// Validate that a value conforms with the validation function.
func (i *IntSetting) Validate(v int64) error {
if i.validateFn != nil {
if err := i.validateFn(v); err != nil {
return err
}
}
return nil
}
func (i *IntSetting) set(v int64) error {
if err := i.Validate(v); err != nil {
return err
}
atomic.StoreInt64(&i.v, v)
return nil
}
func (i *IntSetting) setToDefault() {
if err := i.set(i.defaultValue); err != nil {
panic(err)
}
}
// RegisterIntSetting defines a new setting with type int.
func RegisterIntSetting(key, desc string, defaultValue int64) *IntSetting {
return RegisterValidatedIntSetting(key, desc, defaultValue, nil)
}
// RegisterValidatedIntSetting defines a new setting with type int with a
// validation function.
func RegisterValidatedIntSetting(
key, desc string, defaultValue int64, validateFn func(int64) error,
) *IntSetting {
if validateFn != nil {
if err := validateFn(defaultValue); err != nil {
panic(errors.Wrap(err, "invalid default"))
}
}
setting := &IntSetting{
defaultValue: defaultValue,
validateFn: validateFn,
}
register(key, desc, setting)
return setting
}
// TestingSetInt returns a mock, unregistered int setting for testing. See
// TestingSetBool for more details.
func TestingSetInt(s **IntSetting, v int64) func() {
saved := *s
*s = &IntSetting{v: v}
return func() {
*s = saved
}
}