starter

Documentation

Overview

Package starter used for starting and shuting down application components.

Index

• type Fn
• type Starter
  • func New(ctx context.Context) *Starter
  • func (s *Starter) Cancel(err error)
  • func (s *Starter) OnRun(fns ...Fn) *Starter
  • func (s *Starter) OnShutdown(fns ...Fn) *Starter
  • func (s *Starter) Run() error

Types

type Fn

type Fn func(ctx context.Context) error

Fn type for functions can be injected into starter.

type Starter

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

Starter struct for starting components.

func New

func New(ctx context.Context) *Starter

New creates a new starter.

func (*Starter) Cancel

func (s *Starter) Cancel(err error)

Cancel canceles execution.

func (*Starter) OnRun

func (s *Starter) OnRun(fns ...Fn) *Starter

OnRun mark function for run on run.

func (*Starter) OnShutdown

func (s *Starter) OnShutdown(fns ...Fn) *Starter

OnShutdown mark function for run on termination.

func (*Starter) Run

func (s *Starter) Run() error

Run runs all functions.