framework

Documentation

Overview

Package framework provides the Core DI/service framework. Import this package for cleaner access to the framework types.

Usage:

import "github.com/host-uk/core/pkg/framework"

app, _ := framework.New(
    framework.WithServiceLock(),
)

Index

• Variables
• func MustServiceFor[T any](c *Core, name string) T
• func ServiceFor[T any](c *Core, name string) (T, error)
• type ActionServiceShutdown
• type ActionServiceStartup
• type Config
• type Contract
• type Core
• type Display
• type Error
• type Features
• type Message
• type Option
• type Query
• type QueryHandler
• type Runtime
• type ServiceFactory
• type ServiceRuntime
  • func NewServiceRuntime[T any](c *Core, opts T) *ServiceRuntime[T]
• type Startable
• type Stoppable
• type Task
• type TaskHandler
• type WindowOption

Variables

var (
	New              = core.New
	WithService      = core.WithService
	WithName         = core.WithName
	WithApp          = core.WithApp
	WithAssets       = core.WithAssets
	WithServiceLock  = core.WithServiceLock
	App              = core.App
	E                = core.E
	NewRuntime       = core.NewRuntime
	NewWithFactories = core.NewWithFactories
)

Re-export core functions

Functions

func MustServiceFor

func MustServiceFor[T any](c *Core, name string) T

MustServiceFor retrieves a typed service or panics if not found.

func ServiceFor

func ServiceFor[T any](c *Core, name string) (T, error)

ServiceFor retrieves a typed service from the core container by name.

Types

type ActionServiceShutdown

type ActionServiceShutdown = core.ActionServiceShutdown

Action types

type ActionServiceStartup

type ActionServiceStartup = core.ActionServiceStartup

Action types

type Config

type Config = core.Config

Re-export core types for cleaner imports

type Contract

type Contract = core.Contract

Re-export core types for cleaner imports

type Core

type Core = core.Core

Re-export core types for cleaner imports

type Display

type Display = core.Display

Re-export core types for cleaner imports

type Error

type Error = core.Error

Re-export core types for cleaner imports

type Features

type Features = core.Features

Re-export core types for cleaner imports

type Message

type Message = core.Message

Re-export core types for cleaner imports

type Option

type Option = core.Option

Re-export core types for cleaner imports

type Query

type Query = core.Query

Re-export core types for cleaner imports

type QueryHandler

type QueryHandler = core.QueryHandler

Re-export core types for cleaner imports

type Runtime

type Runtime = core.Runtime

Re-export core types for cleaner imports

type ServiceFactory

type ServiceFactory = core.ServiceFactory

Re-export core types for cleaner imports

type ServiceRuntime

type ServiceRuntime[T any] = core.ServiceRuntime[T]

Re-export core types for cleaner imports

func NewServiceRuntime

func NewServiceRuntime[T any](c *Core, opts T) *ServiceRuntime[T]

NewServiceRuntime creates a new ServiceRuntime for a service.

type Startable

type Startable = core.Startable

Re-export core types for cleaner imports

type Stoppable

type Stoppable = core.Stoppable

Re-export core types for cleaner imports

type Task

type Task = core.Task

Re-export core types for cleaner imports

type TaskHandler

type TaskHandler = core.TaskHandler

Re-export core types for cleaner imports

type WindowOption

type WindowOption = core.WindowOption

Re-export core types for cleaner imports