cleaner.go

/*
 * MIT License
 *
 * Copyright (c) 2024-2025 Arsene Tochemey Gandote
 *
 * 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 gokv

import "time"

// cleaner runs periodically to remove expired entries
// from the localState of the given node
type cleaner struct {
	interval time.Duration
	stop     chan bool
}

// run kick-starts the cleaner job
func (cl *cleaner) run(node *Node) {
	ticker := time.NewTicker(cl.interval)
	for {
		select {
		case <-ticker.C:
			node.delegate.removeExpired()
		case <-cl.stop:
			ticker.Stop()
			return
		}
	}
}

// stopCleaner stops the cleaner job
func stopCleaner(c *Node) {
	c.cleaner.stop <- true
}

// runCleaner runs the cleaner job
func runCleaner(c *Node, ci time.Duration) {
	j := &cleaner{
		interval: ci,
		stop:     make(chan bool),
	}
	c.cleaner = j
	go j.run(c)
}