pkgCtl

README

Package controller

• a modular project management (startup) framework

go get github.com/RealFax/pkg-ctl@latest

how to use

• First add pkg-ctl to your go.mod
• Then refer to the example code to register your package in pkg-ctl

example

Documentation

Index

• func Bootstrap(activeFunc func())
• func Register(seq int, name string, handler HandlerFunc)
• func UseValue[T any](ctx *Context, key string) (T, bool)
• type Context
  • func New(opts ...Option) *Context
  • func Use(ctx context.Context) (*Context, bool)
  • func (c *Context) Del(key string)
  • func (c *Context) Destroy() error
  • func (c *Context) Exit() error
  • func (c *Context) Get(key string) (any, bool)
  • func (c *Context) ListenAndDestroy() error
  • func (c *Context) Set(key string, value any)
  • func (c *Context) Startup() error
  • func (c *Context) Stop()
• type DUnit
• type Handler
• type HandlerFunc
• type Logger
• type Option
  • func WithLogger(logger Logger) Option
  • func WithValues(values map[string]any) Option
• type UnimplementedHandler
  • func (h UnimplementedHandler) Async() bool
  • func (h UnimplementedHandler) Create() error
  • func (h UnimplementedHandler) Destroy() error
  • func (h UnimplementedHandler) Start() error
• type Unit

Examples

• Use
• UseValue

Functions

func Bootstrap

func Bootstrap(activeFunc func())

func Register

func Register(seq int, name string, handler HandlerFunc)

func UseValue

func UseValue[T any](ctx *Context, key string) (T, bool)

Example

package main

import (
	pkgCtl "github.com/RealFax/pkg-ctl"
)

var ctx = pkgCtl.New()

func main() {
	c, ok := pkgCtl.Use(ctx)
	if !ok {
		return
	}

	c.Set("K", "V")

	catch, ok := pkgCtl.UseValue[string](c, "K")
	if !ok {
		return
	}

	if catch != "V" {
		// fail
	}
	// success
}

Types

type Context

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

func New

func New(opts ...Option) *Context

func Use

func Use(ctx context.Context) (*Context, bool)

Example

package main

import (
	pkgCtl "github.com/RealFax/pkg-ctl"
)

var ctx = pkgCtl.New()

func main() {
	c, ok := pkgCtl.Use(ctx)
	if !ok {
		// not pkgCtl.Context
		return
	}

	// call pkgCtl.Context api
	c.Get("Key")
}

func (*Context) Del

func (c *Context) Del(key string)

func (*Context) Destroy

func (c *Context) Destroy() error

func (*Context) Exit

func (c *Context) Exit() error

func (*Context) Get

func (c *Context) Get(key string) (any, bool)

func (*Context) ListenAndDestroy

func (c *Context) ListenAndDestroy() error

func (*Context) Set

func (c *Context) Set(key string, value any)

func (*Context) Startup

func (c *Context) Startup() error

func (*Context) Stop

func (c *Context) Stop()

type DUnit

type DUnit struct {
	Seq  int
	Name string
	Unit Handler
}

type Handler

type Handler interface {
	Create() error
	Start() error
	Destroy() error
	Async() bool
	// contains filtered or unexported methods
}

type HandlerFunc

type HandlerFunc func(*Context) Handler

type Logger

type Logger interface {
	Debug(msg string, v ...any)
	Info(msg string, v ...any)
	Warn(msg string, v ...any)
	Error(msg string, v ...any)
}

type Option

type Option func(*Context)

func WithLogger

func WithLogger(logger Logger) Option

func WithValues

func WithValues(values map[string]any) Option

type UnimplementedHandler

type UnimplementedHandler struct{}

func (UnimplementedHandler) Async

func (h UnimplementedHandler) Async() bool

func (UnimplementedHandler) Create

func (h UnimplementedHandler) Create() error

func (UnimplementedHandler) Destroy

func (h UnimplementedHandler) Destroy() error

func (UnimplementedHandler) Start

func (h UnimplementedHandler) Start() error

type Unit

type Unit struct {
	Seq    int
	Name   string
	Handle HandlerFunc
}