mirrors/tailscale
1
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

prober: rename Probe to ProbeFunc.

Browse Source 
Making way for a future Probe struct to encapsulate per-probe state.

Signed-off-by: David Anderson <danderson@tailscale.com>
This commit is contained in:
David Anderson
2022-03-19 20:58:35 -07:00
committed by Dave Anderson
parent 7b4960316b
commit 94aaec5c66
4 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
prober/prober.go
View File

@ -18,10 +18,10 @@ import (
"tailscale.com/metrics"
)
// Probe is a function that probes something and reports whether the
// ProbeFunc is a function that probes something and reports whether the
// probe succeeded. The provided context must be used to ensure timely
// cancellation and timeout behavior.
type Probe func(context.Context) error
type ProbeFunc func(context.Context) error
// a Prober manages a set of probes and keeps track of their results.
type Prober struct {
@ -101,7 +101,7 @@ func (p *Prober) Expvar() *metrics.Set {
// returns.
//
// Registering a probe under an already-registered name panics.
func (p *Prober) Run(name string, interval time.Duration, fun Probe) context.CancelFunc {
func (p *Prober) Run(name string, interval time.Duration, fun ProbeFunc) context.CancelFunc {
p.mu.Lock()
defer p.mu.Unlock()
ticker := p.registerLocked(name, interval)
@ -120,7 +120,7 @@ func (p *Prober) Run(name string, interval time.Duration, fun Probe) context.Can
// probeLoop invokes runProbe on fun every interval. The first probe
// is run after interval.
func (p *Prober) probeLoop(ctx context.Context, name string, interval time.Duration, tick ticker, fun Probe) {
func (p *Prober) probeLoop(ctx context.Context, name string, interval time.Duration, tick ticker, fun ProbeFunc) {
defer func() {
p.unregister(name)
tick.Stop()
@ -143,7 +143,7 @@ func (p *Prober) probeLoop(ctx context.Context, name string, interval time.Durat
// fun is invoked with a timeout slightly less than interval, so that
// the probe either succeeds or fails before the next cycle is
// scheduled to start.
func (p *Prober) runProbe(ctx context.Context, name string, interval time.Duration, fun Probe) {
func (p *Prober) runProbe(ctx context.Context, name string, interval time.Duration, fun ProbeFunc) {
start := p.start(name)
defer func() {
// Prevent a panic within one probe function from killing the