ticker

Documentation

Overview

Package ticker provides ticker functionality as a module.

Index

• Variables
• type Opt
  • func WithFunc(fn func() error) Opt
  • func WithInterval(d time.Duration) Opt
• type Ticker
  • func New(opts ...Opt) *Ticker
  • func (t *Ticker) Init() error
  • func (t *Ticker) Name() string
  • func (t *Ticker) Run() error
  • func (t *Ticker) Stop() error

Examples

• New

Variables

var (
	ErrMissingWithInterval = fmt.Errorf("ticker.Ticker missing WithInterval option")
	ErrMissingWithFunc     = fmt.Errorf("ticker.Ticker missing WithFunc option")
)

Types

type Opt

type Opt func(*Ticker) error

func WithFunc

func WithFunc(fn func() error) Opt

func WithInterval

func WithInterval(d time.Duration) Opt

type Ticker

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

func New

func New(opts ...Opt) *Ticker

New creates ticker with given options. WithInterval and WithFunc options are mandatory.

Example

package main

import (
	"errors"
	"fmt"
	"log/slog"
	"time"

	"github.com/elisasre/go-common/v2/service"
	"github.com/elisasre/go-common/v2/service/module/ticker"
)

func main() {
	t := ticker.New(
		ticker.WithInterval(time.Second),
		ticker.WithFunc(func() error {
			slog.Info("Hello from ticker")
			return errors.New("ticker error")
		}),
	)

	err := service.Run(service.Modules{t})
	if err != nil {
		fmt.Println(err)
	}
}

Output:

1 error occurred:
	* failed to run module ticker.Ticker: ticker error

func (*Ticker) Init

func (t *Ticker) Init() error

func (*Ticker) Name

func (t *Ticker) Name() string

func (*Ticker) Run

func (t *Ticker) Run() error

func (*Ticker) Stop

func (t *Ticker) Stop() error