brokkr

README

Brokkr

Brokkr micro framework that helps you quickly write simple API's and test it

Run tests

go test -v --race $(go list ./... | (grep -v /vendor/) | (grep -v internal/test/bdd/integration_tests)) -covermode=atomic -coverprofile=coverage.out

Documentation

Index

• type Brokkr
  • func NewBrokkr(opts ...Options) (b *Brokkr)
  • func (c *Brokkr) Start() error
  • func (c *Brokkr) Stop() error
• type Options
  • func AddBackgroundTasks(bt ...background.Process) Options
  • func SetForceStopTimeout(t time.Duration) Options

Types

type Brokkr

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

Brokkr core loop system of the app

func NewBrokkr

func NewBrokkr(opts ...Options) (b *Brokkr)

NewBrokkr framework instance

func (*Brokkr) Start

func (c *Brokkr) Start() error

Start main loop and call callback in the end

func (*Brokkr) Stop

func (c *Brokkr) Stop() error

Stop in graceful mode

type Options

type Options func(o *Brokkr)

Options sets of configurations for Brokkr

func AddBackgroundTasks

func AddBackgroundTasks(bt ...background.Process) Options

AddBackgroundTasks that will be executed in background of main loop

func SetForceStopTimeout

func SetForceStopTimeout(t time.Duration) Options

SetForceStopTimeout redefines force shutdown timeout