runtime

Documentation

Index

• Variables
• func Error(err error)
• func Start(runtimes []Runtime, sleepTime time.Duration) error
• func Stop()
• func Wait()
• type Configuration
  • func HttpWithHandler(handler http.Handler) Configuration[*HttpRunnable]
  • func HttpWithPort(port int) Configuration[*HttpRunnable]
  • func HttpWithReadHeaderTimeout(timeout time.Duration) Configuration[*HttpRunnable]
  • func HttpWithReadTimeout(timeout time.Duration) Configuration[*HttpRunnable]
  • func HttpWithWriteTimeout(timeout time.Duration) Configuration[*HttpRunnable]
  • func LoopWithLoop[C any](loop Loop[C]) Configuration[*LoopRunnable[C]]
• type HttpRunnable
  • func HttpDefault(c *HttpRunnable) *HttpRunnable
  • func (c *HttpRunnable) Run() error
  • func (c *HttpRunnable) Start() error
  • func (c *HttpRunnable) Stop()
• type Loop
• type LoopRunnable
  • func LoopDefault[C any](c *LoopRunnable[C]) *LoopRunnable[C]
  • func (r *LoopRunnable[C]) Run() error
  • func (r *LoopRunnable[C]) Start() error
  • func (r *LoopRunnable[C]) Stop()
• type Primary
  • func (r *Primary) Error()
  • func (r *Primary) Interrupt()
  • func (r *Primary) Start() error
  • func (r *Primary) Stop()
  • func (r *Primary) StopFrom(from int)
  • func (r *Primary) Wait()
• type Runnable
• type Runner
  • func (r *Runner) Run()
  • func (r *Runner) Start() error
  • func (r *Runner) Stop()
• type Runtime
  • func NewHttp(configurations ...Configuration[*HttpRunnable]) Runtime
  • func NewLoop[C any](configurations ...Configuration[*LoopRunnable[C]]) Runtime
  • func NewRunner(runnable Runnable) Runtime

Variables

var (
	ErrHttpMissingServer  = errors.New("http runtime no server provided")
	ErrHttpMissingHandler = errors.New("http runtime no handler provided")
)

Errors

var (
	ErrLoopRuntimeNoLoop     = errors.New("functional runtime no loop function provided")
	ErrLoopRuntimeInitialise = errors.New("functional runtime initialise function failed")
)

Errors

var (
	ErrPrimaryInitialiseError = errors.New("primary runtime initialise function failed")
	ErrPrimaryTesting         = errors.New("primary runtime testing error")
)

Errors

var (
	ErrRunnerRuntimeNoRunnable    = errors.New("runner runtime no runnable provided")
	ErrRunnerRuntimeRunnableStart = errors.New("runner runtime runnable failed to start")
)

Errors

Functions

func Error

func Error(err error)

func Start

func Start(runtimes []Runtime, sleepTime time.Duration) error

func Stop

func Stop()

func Wait

func Wait()

Types

type Configuration

type Configuration[R any] func(R) R

func HttpWithHandler

func HttpWithHandler(handler http.Handler) Configuration[*HttpRunnable]

configuration

func HttpWithPort

func HttpWithPort(port int) Configuration[*HttpRunnable]

func HttpWithReadHeaderTimeout

func HttpWithReadHeaderTimeout(timeout time.Duration) Configuration[*HttpRunnable]

func HttpWithReadTimeout

func HttpWithReadTimeout(timeout time.Duration) Configuration[*HttpRunnable]

func HttpWithWriteTimeout

func HttpWithWriteTimeout(timeout time.Duration) Configuration[*HttpRunnable]

func LoopWithLoop

func LoopWithLoop[C any](loop Loop[C]) Configuration[*LoopRunnable[C]]

configuration

type HttpRunnable

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

implementation

func HttpDefault

func HttpDefault(c *HttpRunnable) *HttpRunnable

default

func (*HttpRunnable) Run

func (c *HttpRunnable) Run() error

func (*HttpRunnable) Start

func (c *HttpRunnable) Start() error

func (*HttpRunnable) Stop

func (c *HttpRunnable) Stop()

type Loop

type Loop[C any] interface {
	Initialise() (C, error)
	Cleanup(C)
	Loop(C, context.CancelFunc) error
}

type LoopRunnable

type LoopRunnable[C any] struct {
	// contains filtered or unexported fields
}

implementation

func LoopDefault

func LoopDefault[C any](c *LoopRunnable[C]) *LoopRunnable[C]

default

func (*LoopRunnable[C]) Run

func (r *LoopRunnable[C]) Run() error

func (*LoopRunnable[C]) Start

func (r *LoopRunnable[C]) Start() error

func (*LoopRunnable[C]) Stop

func (r *LoopRunnable[C]) Stop()

type Primary

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

implementation

func (*Primary) Error

func (r *Primary) Error()

func (*Primary) Interrupt

func (r *Primary) Interrupt()

func (*Primary) Start

func (r *Primary) Start() error

func (*Primary) Stop

func (r *Primary) Stop()

func (*Primary) StopFrom

func (r *Primary) StopFrom(from int)

func (*Primary) Wait

func (r *Primary) Wait()

type Runnable

type Runnable interface {
	Start() error
	Stop()
	Run() error
}

type Runner

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

func (*Runner) Run

func (r *Runner) Run()

func (*Runner) Start

func (r *Runner) Start() error

func (*Runner) Stop

func (r *Runner) Stop()

type Runtime

type Runtime interface {
	Start() error
	Stop()
}

func NewHttp

func NewHttp(configurations ...Configuration[*HttpRunnable]) Runtime

constructor

func NewLoop

func NewLoop[C any](configurations ...Configuration[*LoopRunnable[C]]) Runtime

constructor

func NewRunner

func NewRunner(runnable Runnable) Runtime