mirror of
https://github.com/safing/portmaster
synced 2025-04-25 13:29:10 +00:00
6c014d227c
The time.Ticker object was stored as a value type, but it is expected to be a pointer according to its implementation: ``` func (t *Ticker) Stop() func (t *Ticker) Reset(d Duration) ``` This was leading to an application crash. STR 1: Run `portmaster-core` without privileged rights. It will not be able to start the kernel driver (Windows). During unloading of already initialized modules, the process crashes because of stopping SleepyTicker instances in workers of the "network" module. STR 2: Run tests from `service\mgr\sleepyticker_test.go`
58 lines
1.9 KiB
Go
58 lines
1.9 KiB
Go
package mgr
|
|
|
|
import "time"
|
|
|
|
// SleepyTicker is wrapper over time.Ticker that respects the sleep mode of the module.
|
|
type SleepyTicker struct {
|
|
ticker *time.Ticker
|
|
normalDuration time.Duration
|
|
sleepDuration time.Duration
|
|
sleepMode bool
|
|
|
|
sleepChannel chan time.Time
|
|
}
|
|
|
|
// NewSleepyTicker returns a new SleepyTicker. This is a wrapper of the standard time.Ticker but it respects modules.Module sleep mode. Check https://pkg.go.dev/time#Ticker.
|
|
// If sleepDuration is set to 0 ticker will not tick during sleep.
|
|
func NewSleepyTicker(normalDuration time.Duration, sleepDuration time.Duration) *SleepyTicker {
|
|
st := &SleepyTicker{
|
|
ticker: time.NewTicker(normalDuration),
|
|
normalDuration: normalDuration,
|
|
sleepDuration: sleepDuration,
|
|
sleepMode: false,
|
|
}
|
|
|
|
return st
|
|
}
|
|
|
|
// Wait waits until the module is not in sleep mode and returns time.Ticker.C channel.
|
|
func (st *SleepyTicker) Wait() <-chan time.Time {
|
|
if st.sleepMode && st.sleepDuration == 0 {
|
|
return st.sleepChannel
|
|
}
|
|
return st.ticker.C
|
|
}
|
|
|
|
// Stop turns off a ticker. After Stop, no more ticks will be sent. Stop does not close the channel, to prevent a concurrent goroutine reading from the channel from seeing an erroneous "tick".
|
|
func (st *SleepyTicker) Stop() {
|
|
st.ticker.Stop()
|
|
}
|
|
|
|
// SetSleep sets the sleep mode of the ticker. If enabled is true, the ticker will tick with sleepDuration. If enabled is false, the ticker will tick with normalDuration.
|
|
func (st *SleepyTicker) SetSleep(enabled bool) {
|
|
st.sleepMode = enabled
|
|
if enabled {
|
|
if st.sleepDuration > 0 {
|
|
st.ticker.Reset(st.sleepDuration)
|
|
} else {
|
|
// Next call to Wait will wait until SetSleep is called with enabled == false
|
|
st.sleepChannel = make(chan time.Time)
|
|
}
|
|
} else {
|
|
st.ticker.Reset(st.normalDuration)
|
|
if st.sleepDuration > 0 {
|
|
// Notify that we are not sleeping anymore.
|
|
close(st.sleepChannel)
|
|
}
|
|
}
|
|
}
|