timer

package

v3.30.0 Latest Latest Go to latest Published: Apr 26, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package timer contains a service to store and manage timers in a database

This section is empty.

This section is empty.

This section is empty.

type Service struct {
	// contains filtered or unexported fields
}

Service implements a timer service

func New(db database.Connector, cronService *cron.Cron) (*Service, error)

New creates a new Service

func (s Service) AddCooldown(tt plugins.TimerType, limiter, ruleID string, expiry time.Time) error

AddCooldown adds a new cooldown timer

func (s Service) AddPermit(channel, username string) error

AddPermit adds a new permit timer

func (*Service) CopyDatabase(src, target *gorm.DB) error

CopyDatabase enables the service to migrate to a new database

func (s Service) HasPermit(channel, username string) (bool, error)

HasPermit checks whether a valid permit is present

func (s Service) HasTimer(id string) (bool, error)

HasTimer checks whether a timer with given ID is present

func (s Service) InCooldown(tt plugins.TimerType, limiter, ruleID string) (bool, error)

InCooldown checks whether the cooldown has expired

func (s Service) SetTimer(id string, expiry time.Time) error

SetTimer sets a timer with given ID and expiry

func (s *Service) UpdatePermitTimeout(d time.Duration)

UpdatePermitTimeout sets a new permit timeout for future permits