foundation

Documentation

Index

• type BaseProvider
  • func (*BaseProvider) Bootstrap(ctx context.Context) (context.Context, error)
  • func (*BaseProvider) Terminate(ctx context.Context) (context.Context, error)
• type BootstrapFunc
  • func (f BootstrapFunc) Bootstrap(ctx context.Context) (context.Context, error)
  • func (f BootstrapFunc) Terminate(ctx context.Context) (context.Context, error)
• type Chain
  • func NewChain(providers ...Provider) Chain
  • func (c Chain) Bootstrap(ctx context.Context) (context.Context, error)
  • func (c Chain) Terminate(ctx context.Context) (context.Context, error)
• type Handler
• type HandlerFunc
  • func (f HandlerFunc) Handle(ctx context.Context) error
• type Kernel
  • func NewKernel(opts ...Option) *Kernel
  • func (k *Kernel) Register(providers ...Provider)
  • func (k *Kernel) Run() (err error)
• type Option
  • func WithContext(ctx context.Context) Option
  • func WithHandler(handler Handler) Option
  • func WithProviders(providers ...Provider) Option
  • func WithTerminateTimeout(timeout time.Duration) Option
• type Provider
• type TerminateFunc
  • func (f TerminateFunc) Bootstrap(ctx context.Context) (context.Context, error)
  • func (f TerminateFunc) Terminate(ctx context.Context) (context.Context, error)

Types

type BaseProvider

type BaseProvider struct{}

BaseProvider is a provider that does nothing.

func (*BaseProvider) Bootstrap

func (*BaseProvider) Bootstrap(ctx context.Context) (context.Context, error)

func (*BaseProvider) Terminate

func (*BaseProvider) Terminate(ctx context.Context) (context.Context, error)

type BootstrapFunc

type BootstrapFunc func(context.Context) (context.Context, error)

func (BootstrapFunc) Bootstrap

func (f BootstrapFunc) Bootstrap(ctx context.Context) (context.Context, error)

func (BootstrapFunc) Terminate

func (f BootstrapFunc) Terminate(ctx context.Context) (context.Context, error)

type Chain

type Chain []Provider

Chain is a provider that calls multiple providers in sequence.

func NewChain

func NewChain(providers ...Provider) Chain

func (Chain) Bootstrap

func (c Chain) Bootstrap(ctx context.Context) (context.Context, error)

func (Chain) Terminate

func (c Chain) Terminate(ctx context.Context) (context.Context, error)

type Handler

type Handler interface {
	Handle(ctx context.Context) error
}

type HandlerFunc

type HandlerFunc func(ctx context.Context) error

func (HandlerFunc) Handle

func (f HandlerFunc) Handle(ctx context.Context) error

type Kernel

type Kernel struct {
	context.Context
	// contains filtered or unexported fields
}

func NewKernel

func NewKernel(opts ...Option) *Kernel

func (*Kernel) Register

func (k *Kernel) Register(providers ...Provider)

func (*Kernel) Run

func (k *Kernel) Run() (err error)

type Option

type Option func(*Kernel)

func WithContext

func WithContext(ctx context.Context) Option

func WithHandler

func WithHandler(handler Handler) Option

func WithProviders

func WithProviders(providers ...Provider) Option

func WithTerminateTimeout

func WithTerminateTimeout(timeout time.Duration) Option

type Provider

type Provider interface {
	Bootstrap(context.Context) (context.Context, error)
	Terminate(context.Context) (context.Context, error)
}

type TerminateFunc

type TerminateFunc func(context.Context) (context.Context, error)

func (TerminateFunc) Bootstrap

func (f TerminateFunc) Bootstrap(ctx context.Context) (context.Context, error)

func (TerminateFunc) Terminate

func (f TerminateFunc) Terminate(ctx context.Context) (context.Context, error)