runtime

Documentation

Index

• Variables
• func ContextValueBool(ctx context.Context, name string) bool
• func ContextValueInt32(ctx context.Context, name string) int32
• func ContextValueInt64(ctx context.Context, name string) int64
• func ContextValueString(ctx context.Context, name string) string
• func ContextWithValueMap(ctx context.Context, valueMap map[string]any) context.Context
• func Error(err error)
• func QualifierConfig(q string) string
• 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]
• type Constructor
  • func ConstructorFor[R any, I any](defaultValue func() R, casting func(R) I) Constructor[R, I]
• type ContextKey
  • func Context(name string) ContextKey
• type HttpRunnable
  • func (c *HttpRunnable) Run() error
  • func (c *HttpRunnable) Start() error
  • func (c *HttpRunnable) Stop()
• type Loop
• type LoopRunnable
  • func (r *LoopRunnable) Run() error
  • func (r *LoopRunnable) Start() error
  • func (r *LoopRunnable) 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 Resolver
  • func NewResolver[T any, I any](qualifier string, container inverse.Container, configurationRequired bool, ...) Resolver[T]
• type Runnable
• type Runner
  • func (r *Runner) Run()
  • func (r *Runner) Start() error
  • func (r *Runner) Stop()
• type Runtime
  • func NewLoop(loop Loop) 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 (
	ErrRunnerRuntimeNoRunnable    = errors.New("runner runtime no runnable provided")
	ErrRunnerRuntimeRunnableStart = errors.New("runner runtime runnable failed to start")
)

Errors

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

Errors

var NewHttp = ConstructorFor[*HttpRunnable, Runtime](
	func() *HttpRunnable {
		return &HttpRunnable{
			server: &http.Server{
				Addr:         ":8080",
				ReadTimeout:  5 * time.Second,
				WriteTimeout: 5 * time.Second,
			},
		}
	},
	func(hr *HttpRunnable) Runtime {
		return NewRunner(hr)
	},
)

constructor

Functions

func ContextValueBool

func ContextValueBool(ctx context.Context, name string) bool

func ContextValueInt32

func ContextValueInt32(ctx context.Context, name string) int32

func ContextValueInt64

func ContextValueInt64(ctx context.Context, name string) int64

func ContextValueString

func ContextValueString(ctx context.Context, name string) string

func ContextWithValueMap

func ContextWithValueMap(ctx context.Context, valueMap map[string]any) context.Context

func Error

func Error(err error)

func QualifierConfig

func QualifierConfig(q string) string

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]

type Constructor

type Constructor[R any, I any] func(...Configuration[R]) I

func ConstructorFor

func ConstructorFor[R any, I any](defaultValue func() R, casting func(R) I) Constructor[R, I]

type ContextKey

type ContextKey struct {
	Name string
}

func Context

func Context(name string) ContextKey

type HttpRunnable

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

implementation

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 interface {
	Start() error
	Stop()
	Loop(context.Context, context.CancelFunc) error
}

type LoopRunnable

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

implementation

func (*LoopRunnable) Run

func (r *LoopRunnable) Run() error

func (*LoopRunnable) Start

func (r *LoopRunnable) Start() error

func (*LoopRunnable) Stop

func (r *LoopRunnable) 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 Resolver

type Resolver[T any] interface {
	AddConfig(inverse.Injector[Configuration[T]])
	AddConfigVal(Configuration[T])
	Register()
}

func NewResolver

func NewResolver[T any, I any](
	qualifier string,
	container inverse.Container,
	configurationRequired bool,
	constructor Constructor[T, I],
) Resolver[T]

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 NewLoop

func NewLoop(loop Loop) Runtime

constructor

func NewRunner

func NewRunner(runnable Runnable) Runtime