loop

Documentation

Overview

Package loop provides a recurring-prompt scheduler for the piglet loop extension. It is free of SDK dependencies and fully testable in isolation.

Index

• Variables
• func Register(e *sdk.Extension)
• type Scheduler
  • func (s *Scheduler) Start(interval time.Duration, prompt string, ...) error
  • func (s *Scheduler) Status() (running bool, interval time.Duration, prompt string, iterations int)
  • func (s *Scheduler) Stop() bool

Variables

var MinInterval = 30 * time.Second

MinInterval is the minimum allowed scheduling interval. Tests may lower this to speed up timing assertions.

Functions

func Register

func Register(e *sdk.Extension)

Register adds loop's prompt section and commands to the extension.

Types

type Scheduler

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

Scheduler runs a prompt on a recurring interval. All methods are safe for concurrent use.

func (*Scheduler) Start

func (s *Scheduler) Start(interval time.Duration, prompt string, onTick func(iteration int, prompt string)) error

Start launches the scheduler. It calls onTick immediately (iteration 1), then again after each interval. Returns an error if:

• interval < MinInterval
• the scheduler is already running

func (*Scheduler) Status

func (s *Scheduler) Status() (running bool, interval time.Duration, prompt string, iterations int)

Status returns the current scheduler state.

func (*Scheduler) Stop

func (s *Scheduler) Stop() bool

Stop cancels the active loop and waits for the goroutine to exit. Returns true if a loop was running, false if there was nothing to stop.