timer

Documentation

Overview

Package timer operates the Focus countdown timer and handles the recovery of interrupted timers

Index

• func Delete(db store.DB) error
• func Recover(db store.DB, ctx *cli.Context) (*Timer, *Session, error)
• type Remainder
• type Session
  • func (s *Session) ElapsedTimeInSeconds() float64
  • func (s *Session) IsResuming() bool
  • func (s *Session) Normalise(c context.Context)
  • func (s *Session) RealElapsedTimeInSeconds() float64
  • func (s *Session) Remaining() Remainder
  • func (s *Session) SetEndTime()
  • func (s *Session) ToDBModel() *models.Session
  • func (s *Session) UpdateEndTime()
• type Settled
  • func (s Settled) Signal()
  • func (s Settled) String() string
• type Status
• type Timeline
• type Timer
  • func New(dbClient store.DB, cfg *config.TimerConfig) (*Timer, error)
  • func (t *Timer) LogValue() slog.Value
  • func (t *Timer) NewSession(c context.Context, name config.SessType, startTime time.Time) *Session
  • func (t *Timer) Persist(c context.Context, sess *Session) error
  • func (t *Timer) ReportStatus() error
  • func (t *Timer) Run(c context.Context, sess *Session) error

Functions

func Delete

func Delete(db store.DB) error

Delete permanently removes one or more paused timers.

func Recover

func Recover(
	db store.DB,
	ctx *cli.Context,
) (*Timer, *Session, error)

Recover attempts to recover an interrupted timer.

Types

type Remainder

type Remainder struct {
	T int // total
	M int // minutes
	S int // seconds
}

Remainder is the time remaining in an active session.

type Session

type Session struct {
	StartTime time.Time       `json:"start_time"`
	EndTime   time.Time       `json:"end_time"`
	Name      config.SessType `json:"name"`
	Tags      []string        `json:"tags"`
	Timeline  []Timeline      `json:"timeline"`
	Duration  time.Duration   `json:"duration"`
	Completed bool            `json:"completed"`
}

Session represents an active work or break session.

func (*Session) ElapsedTimeInSeconds

func (s *Session) ElapsedTimeInSeconds() float64

ElapsedTimeInSeconds returns the time elapsed for the current session in seconds using monotonic timings.

func (*Session) IsResuming

func (s *Session) IsResuming() bool

IsResuming determines if a session is being resumed or not.

func (*Session) Normalise

func (s *Session) Normalise(c context.Context)

Normalise ensures that the end time for the current session perfectly correlates with what is required to complete the session. It mostly helps with normalising the end time when the system is suspended with a session in progress, and resumed at a later time in the future that surpasses the normal end time.

func (*Session) RealElapsedTimeInSeconds

func (s *Session) RealElapsedTimeInSeconds() float64

RealElapsedTimeInSeconds returns the time elapsed for the current session in seconds using real timings.

func (*Session) Remaining

func (s *Session) Remaining() Remainder

Remaining calculates the time remaining for the session to end.

func (*Session) SetEndTime

func (s *Session) SetEndTime()

SetEndTime calculates the end time for the current session.

func (*Session) ToDBModel

func (s *Session) ToDBModel() *models.Session

ToDBModel converts an active session to a database model.

func (*Session) UpdateEndTime

func (s *Session) UpdateEndTime()

UpdateEndTime sets the session end time to the current time.

type Settled

type Settled struct{}

Settled fulfills the os.Signal interface.

func (Settled) Signal

func (s Settled) Signal()

func (Settled) String

func (s Settled) String() string

type Status

type Status struct {
	EndTime           time.Time       `json:"end_date"`
	Name              config.SessType `json:"name"`
	Tags              []string        `json:"tags"`
	WorkCycle         int             `json:"work_cycle"`
	LongBreakInterval int             `json:"long_break_interval"`
}

Status represents the status of a running timer.

type Timeline

type Timeline struct {
	// StartTime is the start of the session including
	// the start of a paused session
	StartTime time.Time `json:"start_time"`
	// EndTime is the end of a session including
	// when a session is paused or stopped prematurely
	EndTime time.Time `json:"end_time"`
}

type Timer

type Timer struct {
	Opts        *config.TimerConfig `json:"opts"`
	SoundStream beep.Streamer       `json:"-"`
	PausedTime  time.Time           `json:"paused_time"`
	StartTime   time.Time           `json:"start_time"`
	SessionKey  time.Time           `json:"session_key"`
	WorkCycle   int                 `json:"work_cycle"`
	// contains filtered or unexported fields
}

Timer represents a running timer.

func New

func New(dbClient store.DB, cfg *config.TimerConfig) (*Timer, error)

New creates a new timer.

func (*Timer) LogValue

func (t *Timer) LogValue() slog.Value

func (*Timer) NewSession

func (t *Timer) NewSession(
	c context.Context,
	name config.SessType,
	startTime time.Time,
) *Session

NewSession initialises a new session.

func (*Timer) Persist

func (t *Timer) Persist(c context.Context, sess *Session) error

Persist saves the current timer and session to the database.

func (*Timer) ReportStatus

func (t *Timer) ReportStatus() error

ReportStatus reports the status of the currently running timer.

func (*Timer) Run

func (t *Timer) Run(c context.Context, sess *Session) error

Run begins the timer and loops forever, alternating between work and break sessions until it is terminated with Ctrl-C or a maximum number of work sessions is reached.