runner

Documentation

Index

• func WithBaseContext(ctx context.Context) option
• func WithBoardSize(rows, columns int) option
• func WithClockInterval(interval time.Duration) option
• func WithCloseGracePeriod(duration time.Duration) option
• func WithInitBoard(initBoard *board.Board) option
• func WithInitFn(fn func(point board.Point) bool) option
• func WithListener(listener chan<- *board.Board) option
• type Runner
  • func New(optionFns ...option) (*Runner, error)
  • func (g *Runner) AddListener(l chan<- *board.Board)
  • func (g *Runner) BoardSize() (int, int)
  • func (g *Runner) ClockInterval() time.Duration
  • func (g *Runner) Close() error
  • func (g *Runner) LoopError() error
  • func (g *Runner) RemoveListener(l chan<- *board.Board)
  • func (g *Runner) Start() error
• type State
  • func (i State) String() string

Functions

func WithBaseContext

func WithBaseContext(ctx context.Context) option

func WithBoardSize

func WithBoardSize(rows, columns int) option

func WithClockInterval

func WithClockInterval(interval time.Duration) option

func WithCloseGracePeriod

func WithCloseGracePeriod(duration time.Duration) option

func WithInitBoard

func WithInitBoard(initBoard *board.Board) option

func WithInitFn

func WithInitFn(fn func(point board.Point) bool) option

func WithListener

func WithListener(listener chan<- *board.Board) option

Types

type Runner

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

func New

func New(optionFns ...option) (*Runner, error)

func (*Runner) AddListener

func (g *Runner) AddListener(l chan<- *board.Board)

func (*Runner) BoardSize

func (g *Runner) BoardSize() (int, int)

func (*Runner) ClockInterval

func (g *Runner) ClockInterval() time.Duration

func (*Runner) Close

func (g *Runner) Close() error

Close closes the

func (*Runner) LoopError

func (g *Runner) LoopError() error

func (*Runner) RemoveListener

func (g *Runner) RemoveListener(l chan<- *board.Board)

func (*Runner) Start

func (g *Runner) Start() error

Start starts the Runner clock. This function is Idempotent so calling it after the engine started does nothing.

type State

type State uint32

const (
	Stopped State = iota
	Starting
	Running
	Stopping
	Errored
)

func (State) String

func (i State) String() string