timer

Documentation

Overview

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

Index

• type Service
  • func New(db database.Connector, cronService *cron.Cron) (*Service, error)
  • func (s Service) AddCooldown(tt plugins.TimerType, limiter, ruleID string, expiry time.Time) error
  • func (s Service) AddPermit(channel, username string) error
  • func (*Service) CopyDatabase(src, target *gorm.DB) error
  • func (s Service) HasPermit(channel, username string) (bool, error)
  • func (s Service) HasTimer(id string) (bool, error)
  • func (s Service) InCooldown(tt plugins.TimerType, limiter, ruleID string) (bool, error)
  • func (s Service) SetTimer(id string, expiry time.Time) error
  • func (s *Service) UpdatePermitTimeout(d time.Duration)

Types

type Service

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

Service implements a timer service

func New

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

New creates a new Service

func (Service) AddCooldown

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

AddCooldown adds a new cooldown timer

func (Service) AddPermit

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

AddPermit adds a new permit timer

func (*Service) CopyDatabase

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

CopyDatabase enables the service to migrate to a new database

func (Service) HasPermit

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

HasPermit checks whether a valid permit is present

func (Service) HasTimer

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

HasTimer checks whether a timer with given ID is present

func (Service) InCooldown

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

InCooldown checks whether the cooldown has expired

func (Service) SetTimer

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

SetTimer sets a timer with given ID and expiry

func (*Service) UpdatePermitTimeout

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

UpdatePermitTimeout sets a new permit timeout for future permits