298322ed89
Renames (via GoLand refactor): - Option.K → Key, Option.V → Value - Err.Op → Operation, Err.Msg → Message, Err.Err → Error - CrashSystem.OS → OperatingSystem, Arch → Architecture - TaskID → TaskIdentifier, TaskWithID → TaskWithIdentifier - Ipc → IPC, BaseDir → BaseDirectory - ServiceRuntime.Opts → Options Return type changes: - Options.Get, Config.Get → Result (was (any, bool)) - Embed.ReadDir → Result (was ([]fs.DirEntry, error)) - Translator.Translate, I18n.Translate → Result (was string) Rule 6: - data.go: propagate opts.Get failure, typed error for bad fs.FS Co-Authored-By: Virgil <virgil@lethean.io>
100 lines
2.1 KiB
Go
100 lines
2.1 KiB
Go
// SPDX-License-Identifier: EUPL-1.2
|
|
|
|
// Contracts, options, and type definitions for the Core framework.
|
|
|
|
package core
|
|
|
|
import (
|
|
"context"
|
|
)
|
|
|
|
// Message is the type for IPC broadcasts (fire-and-forget).
|
|
type Message any
|
|
|
|
// Query is the type for read-only IPC requests.
|
|
type Query any
|
|
|
|
// Task is the type for IPC requests that perform side effects.
|
|
type Task any
|
|
|
|
// TaskWithID is an optional interface for tasks that need to know their assigned ID.
|
|
type TaskWithID interface {
|
|
Task
|
|
TaskWithIdentifier(id string)
|
|
GetTaskIdentifier() string
|
|
}
|
|
|
|
// QueryHandler handles Query requests. Returns Result{Value, OK}.
|
|
type QueryHandler func(*Core, Query) Result
|
|
|
|
// TaskHandler handles Task requests. Returns Result{Value, OK}.
|
|
type TaskHandler func(*Core, Task) Result
|
|
|
|
// Startable is implemented by services that need startup initialisation.
|
|
type Startable interface {
|
|
OnStartup(ctx context.Context) error
|
|
}
|
|
|
|
// Stoppable is implemented by services that need shutdown cleanup.
|
|
type Stoppable interface {
|
|
OnShutdown(ctx context.Context) error
|
|
}
|
|
|
|
// --- Action Messages ---
|
|
|
|
type ActionServiceStartup struct{}
|
|
type ActionServiceShutdown struct{}
|
|
|
|
type ActionTaskStarted struct {
|
|
TaskIdentifier string
|
|
Task Task
|
|
}
|
|
|
|
type ActionTaskProgress struct {
|
|
TaskIdentifier string
|
|
Task Task
|
|
Progress float64
|
|
Message string
|
|
}
|
|
|
|
type ActionTaskCompleted struct {
|
|
TaskIdentifier string
|
|
Task Task
|
|
Result any
|
|
Error error
|
|
}
|
|
|
|
// --- Constructor ---
|
|
|
|
// New creates a Core instance.
|
|
//
|
|
// c := core.New(core.Options{
|
|
// {Key: "name", Value: "myapp"},
|
|
// })
|
|
func New(opts ...Options) *Core {
|
|
c := &Core{
|
|
app: &App{},
|
|
data: &Data{},
|
|
drive: &Drive{},
|
|
fs: &Fs{root: "/"},
|
|
config: &Config{ConfigOptions: &ConfigOptions{}},
|
|
error: &ErrorPanic{},
|
|
log: &ErrorLog{log: defaultLog},
|
|
lock: &Lock{},
|
|
ipc: &Ipc{},
|
|
i18n: &I18n{},
|
|
}
|
|
|
|
if len(opts) > 0 {
|
|
c.options = &opts[0]
|
|
name := opts[0].String("name")
|
|
if name != "" {
|
|
c.app.Name = name
|
|
}
|
|
}
|
|
|
|
// Init Cli surface with Core reference
|
|
c.cli = &Cli{core: c}
|
|
|
|
return c
|
|
}
|