Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

kengine

package module

Go to main page

Versions in this module

v1

v1.0.4

Sep 29, 2024

Changes in this version

+ const DefaultLoggerName

+ const ExitCodeFailedQuit

+ const ExitCodeFailedStartup

+ const ExitCodeForceQuit

+ const ExitCodeSuccess

+ const ImportPath

+ var ConfigAutosavePath = filepath.Join(AppConfigDir(), "autosave.json")

+ var CustomVersion string

+ var DefaultAdminListen = "localhost:2019"

+ var DefaultRemoteAdminListen = ":2021"

+ var DefaultStorage = &certmagic.FileStorage

+ var ErrNotConfigured = fmt.Errorf("module not configured")

+ func AppConfigDir() string

+ func AppDataDir() string

+ func Exiting() bool

+ func GetModuleID(instance any) string

+ func GetModuleName(instance any) string

+ func HomeDir() string

+ func InstanceID() (uuid.UUID, error)

+ func IsUnixNetwork(netw string) bool

+ func IsWriterStandardStream(wo WriterOpener) bool

+ func JoinNetworkAddress(network, host, port string) string

+ func ListenerUsage(network, addr string) int

+ func Load(cfgJSON []byte, forceReload bool) error

+ func Log() *zap.Logger

+ func Modules() []string

+ func OnExit(f func(context.Context))

+ func PIDFile(filename string) error

+ func ParseDuration(s string) (time.Duration, error)

+ func ParseStructTag(tag string) (map[string]string, error)

+ func RegisterModule(instance Module)

+ func RegisterNetwork(network string, getListener ListenerFunc)

+ func RemoveMetaFields(rawJSON []byte) []byte

+ func Run(cfg *Config) error

+ func SplitNetworkAddress(a string) (network, host, port string, err error)

+ func StrictUnmarshalJSON(data []byte, v any) error

+ func ToString(val any) string

+ func Validate(cfg *Config) error

+ func Version() (simple, full string)

+ type APIError struct

+ Err error

+ HTTPStatus int

+ Message string

+ func (e APIError) Error() string

+ type AdminAccess struct

+ Permissions []AdminPermissions

+ PublicKeys []string

+ type AdminConfig struct

+ Config *ConfigSettings

+ Disabled bool

+ EnforceOrigin bool

+ Identity *IdentityConfig

+ Listen string

+ Origins []string

+ Remote *RemoteAdmin

+ type AdminHandler interface

+ ServeHTTP func(http.ResponseWriter, *http.Request) error

+ type AdminHandlerFunc func(http.ResponseWriter, *http.Request) error

+ func (f AdminHandlerFunc) ServeHTTP(w http.ResponseWriter, r *http.Request) error

+ type AdminPermissions struct

+ Methods []string

+ Paths []string

+ type AdminRoute struct

+ Handler AdminHandler

+ Pattern string

+ type AdminRouter interface

+ Routes func() []AdminRoute

+ type App interface

+ Start func() error

+ Stop func() error

+ type BaseLog struct

+ CoreRaw json.RawMessage

+ EncoderRaw json.RawMessage

+ Level string

+ Sampling *LogSampling

+ WithCaller bool

+ WithCallerSkip int

+ WithStacktrace string

+ WriterRaw json.RawMessage

+ type CleanerUpper interface

+ Cleanup func() error

+ type Config struct

+ Admin *AdminConfig

+ AppsRaw ModuleMap

+ Logging *Logging

+ StorageRaw json.RawMessage

+ type ConfigLoader interface

+ LoadConfig func(Context) ([]byte, error)

+ type ConfigSettings struct

+ LoadDelay Duration

+ LoadRaw json.RawMessage

+ Persist *bool

+ type ConfiguresFormatterDefault interface

+ ConfigureDefaultFormat func(WriterOpener) error

+ type Constructor func() (Destructor, error)

type Context

+ func ActiveContext() Context

+ func NewContext(ctx Context) (Context, context.CancelFunc)

+ func ProvisionContext(newCfg *Config) (Context, error)

+ func (ctx *Context) Filesystems() FileSystems

+ func (ctx *Context) OnCancel(f func())

+ func (ctx *Context) OnExit(f func(context.Context))

+ func (ctx *Context) WithValue(key, value any) Context

+ func (ctx Context) App(name string) (any, error)

+ func (ctx Context) AppIfConfigured(name string) (any, error)

+ func (ctx Context) IdentityCredentials(logger *zap.Logger) ([]tls.Certificate, error)

+ func (ctx Context) LoadModule(structPointer any, fieldName string) (any, error)

+ func (ctx Context) LoadModuleByID(id string, rawMsg json.RawMessage) (any, error)

+ func (ctx Context) Logger(module ...Module) *zap.Logger

+ func (ctx Context) Module() Module

+ func (ctx Context) Modules() []Module

+ func (ctx Context) Slogger() *slog.Logger

+ func (ctx Context) Storage() certmagic.Storage

type CtxKey

+ const ReplacerCtxKey

+ type CustomLog struct

+ Exclude []string

+ Include []string

+ type Destructor interface

+ Destruct func() error

+ type DiscardWriter struct

+ func (DiscardWriter) KengineModule() ModuleInfo

+ func (DiscardWriter) OpenWriter() (io.WriteCloser, error)

+ func (DiscardWriter) String() string

+ func (DiscardWriter) WriterKey() string

+ type Duration time.Duration

+ func (d *Duration) UnmarshalJSON(b []byte) error

+ type FileSystems interface

+ Default func() fs.FS

+ Get func(k string) (v fs.FS, ok bool)

+ Register func(k string, v fs.FS)

+ Unregister func(k string)

+ type IdentityConfig struct

+ Identifiers []string

+ IssuersRaw []json.RawMessage

+ type ListenerFunc func(ctx context.Context, network, addr string, cfg net.ListenConfig) (any, error)

+ type ListenerWrapper interface

+ WrapListener func(net.Listener) net.Listener

+ type LogSampling struct

+ First int

+ Interval time.Duration

+ Thereafter int

+ type Logging struct

+ Logs map[string]*CustomLog

+ Sink *SinkLog

+ func (logging *Logging) Logger(mod Module) *zap.Logger

+ type Module interface

+ KengineModule func() ModuleInfo

+ type ModuleID string

+ func (id ModuleID) Name() string

+ func (id ModuleID) Namespace() string

+ type ModuleInfo struct

+ ID ModuleID

+ New func() Module

+ func GetModule(name string) (ModuleInfo, error)

+ func GetModules(scope string) []ModuleInfo

+ func (mi ModuleInfo) String() string

+ type ModuleMap map[string]json.RawMessage

+ type NetworkAddress struct

+ EndPort uint

+ Host string

+ Network string

+ StartPort uint

+ func ParseNetworkAddress(addr string) (NetworkAddress, error)

+ func ParseNetworkAddressWithDefaults(addr, defaultNetwork string, defaultPort uint) (NetworkAddress, error)

+ func (na NetworkAddress) At(portOffset uint) NetworkAddress

+ func (na NetworkAddress) Expand() []NetworkAddress

+ func (na NetworkAddress) IsUnixNetwork() bool

+ func (na NetworkAddress) JoinHostPort(offset uint) string

+ func (na NetworkAddress) Listen(ctx context.Context, portOffset uint, config net.ListenConfig) (any, error)

+ func (na NetworkAddress) ListenAll(ctx context.Context, config net.ListenConfig) ([]any, error)

+ func (na NetworkAddress) ListenQUIC(ctx context.Context, portOffset uint, config net.ListenConfig, ...) (http3.QUICEarlyListener, error)

+ func (na NetworkAddress) PortRangeSize() uint

+ func (na NetworkAddress) String() string

+ type Provisioner interface

+ Provision func(Context) error

+ type RemoteAdmin struct

+ AccessControl []*AdminAccess

+ Listen string

+ type ReplacementFunc func(variable string, val any) (any, error)

+ type Replacer struct

+ func NewEmptyReplacer() *Replacer

+ func NewReplacer() *Replacer

+ func (r *Replacer) Delete(variable string)

+ func (r *Replacer) Get(variable string) (any, bool)

+ func (r *Replacer) GetString(variable string) (string, bool)

+ func (r *Replacer) Map(mapFunc ReplacerFunc)

+ func (r *Replacer) ReplaceAll(input, empty string) string

+ func (r *Replacer) ReplaceFunc(input string, f ReplacementFunc) (string, error)

+ func (r *Replacer) ReplaceKnown(input, empty string) string

+ func (r *Replacer) ReplaceOrErr(input string, errOnEmpty, errOnUnknown bool) (string, error)

+ func (r *Replacer) Set(variable string, value any)

+ func (r *Replacer) WithoutFile() *Replacer

+ type ReplacerFunc func(key string) (any, bool)

+ type SinkLog struct

+ type StderrWriter struct

+ func (StderrWriter) KengineModule() ModuleInfo

+ func (StderrWriter) OpenWriter() (io.WriteCloser, error)

+ func (StderrWriter) String() string

+ func (StderrWriter) WriterKey() string

+ type StdoutWriter struct

+ func (StdoutWriter) KengineModule() ModuleInfo

+ func (StdoutWriter) OpenWriter() (io.WriteCloser, error)

+ func (StdoutWriter) String() string

+ func (StdoutWriter) WriterKey() string

+ type StorageConverter interface

+ CertMagicStorage func() (certmagic.Storage, error)

+ type UsagePool struct

+ func NewUsagePool() *UsagePool

+ func (up *UsagePool) Delete(key any) (deleted bool, err error)

+ func (up *UsagePool) LoadOrNew(key any, construct Constructor) (value any, loaded bool, err error)

+ func (up *UsagePool) LoadOrStore(key, val any) (value any, loaded bool)

+ func (up *UsagePool) Range(f func(key, value any) bool)

+ func (up *UsagePool) References(key any) (int, bool)

+ type Validator interface

+ Validate func() error

+ type WriterOpener interface

+ OpenWriter func() (io.WriteCloser, error)

+ WriterKey func() string

v1.0.0

Sep 29, 2024

Changes in this version

+ const CertRenewEvent

+ const InstanceRestartEvent

+ const InstanceStartupEvent

+ const ShutdownEvent

+ const StartupEvent

+ var AppName string

+ var AppVersion string

+ var DefaultConfigFile = "Kenginefile"

+ var GracefulTimeout time.Duration

+ var OnProcessExit []func()

+ var PidFile string

+ var Quiet bool

+ func AssetsPath() string

+ func DescribePlugins() string

+ func EmitEvent(event EventName, info interface{})

+ func IsInternal(addr string) bool

+ func IsLoopback(addr string) bool

+ func IsUpgrade() bool

+ func ListPlugins() map[string][]string

+ func RegisterEventHook(name string, hook EventHook)

+ func RegisterKenginefileLoader(name string, loader Loader)

+ func RegisterParsingCallback(serverType, afterDir string, callback ParsingCallback)

+ func RegisterPlugin(name string, plugin Plugin)

+ func RegisterServerType(typeName string, srv ServerType)

+ func SetDefaultKenginefileLoader(name string, loader Loader)

+ func SplitCommandAndArgs(command string) (cmd string, args []string, err error)

+ func Started() bool

+ func Stop() error

+ func TrapSignals()

+ func Upgrade() error

+ func ValidDirectives(serverType string) []string

+ func ValidateAndExecuteDirectives(cdyfile Input, inst *Instance, justValidate bool) error

+ type AfterStartup interface

+ OnStartupComplete func()

+ type Context interface

+ InspectServerBlocks func(string, []kenginefile.ServerBlock) ([]kenginefile.ServerBlock, error)

+ MakeServers func() ([]Server, error)

+ type Controller struct

+ Key string

+ OncePerServerBlock func(f func() error) error

+ ServerBlockIndex int

+ ServerBlockKeyIndex int

+ ServerBlockKeys []string

+ ServerBlockStorage interface{}

+ func NewTestController(serverType, input string) *Controller

+ func (c *Controller) Context() Context

+ func (c *Controller) Get(key interface{}) interface{}

+ func (c *Controller) OnFinalShutdown(fn func() error)

+ func (c *Controller) OnFirstStartup(fn func() error)

+ func (c *Controller) OnRestart(fn func() error)

+ func (c *Controller) OnRestartFailed(fn func() error)

+ func (c *Controller) OnShutdown(fn func() error)

+ func (c *Controller) OnStartup(fn func() error)

+ func (c *Controller) ServerType() string

+ func (c *Controller) Set(key, val interface{})

+ type CtxKey string

+ type EventHook func(eventType EventName, eventInfo interface{}) error

+ type EventName string

+ type GracefulServer interface

+ Address func() string

+ WrapListener func(net.Listener) net.Listener

+ type Input interface

+ Body func() []byte

+ Path func() string

+ ServerType func() string

+ func DefaultInput(serverType string) Input

+ func KenginefileFromPipe(f *os.File, serverType string) (Input, error)

+ func LoadKenginefile(serverType string) (Input, error)

+ type Instance struct

+ OnFinalShutdown []func() error

+ OnFirstStartup []func() error

+ OnRestart []func() error

+ OnRestartFailed []func() error

+ OnShutdown []func() error

+ OnStartup []func() error

+ Storage map[interface{}]interface{}

+ StorageMu sync.RWMutex

+ func Instances() []*Instance

+ func Start(cdyfile Input) (*Instance, error)

+ func (i *Instance) Kenginefile() Input

+ func (i *Instance) Restart(newKenginefile Input) (*Instance, error)

+ func (i *Instance) SaveServer(s Server, ln net.Listener)

+ func (i *Instance) Servers() []ServerListener

+ func (i *Instance) ShutdownCallbacks() []error

+ func (i *Instance) Stop() error

+ func (i *Instance) Wait()

+ type KenginefileInput struct

+ Contents []byte

+ Filepath string

+ ServerTypeName string

+ func (c KenginefileInput) Body() []byte

+ func (c KenginefileInput) Path() string

+ func (c KenginefileInput) ServerType() string

+ type Listener interface

+ File func() (*os.File, error)

+ type Loader interface

+ Load func(serverType string) (Input, error)

+ type LoaderFunc func(serverType string) (Input, error)

+ func (lf LoaderFunc) Load(serverType string) (Input, error)

+ type PacketConn interface

+ File func() (*os.File, error)

+ type ParsingCallback func(Context) error

+ type Plugin struct

+ Action SetupFunc

+ ServerType string

+ type Server interface

+ type ServerListener struct

+ func (s ServerListener) Addr() net.Addr

+ func (s ServerListener) LocalAddr() net.Addr

+ type ServerType struct

+ DefaultInput func() Input

+ Directives func() []string

+ NewContext func(inst *Instance) Context

+ type SetupFunc func(c *Controller) error

+ func DirectiveAction(serverType, dir string) (SetupFunc, error)

+ type Stopper interface

+ Stop func() error

+ type TCPServer interface

+ Listen func() (net.Listener, error)

+ Serve func(net.Listener) error

+ type UDPServer interface

+ ListenPacket func() (net.PacketConn, error)

+ ServePacket func(net.PacketConn) error

Other modules containing this package

github.com/khulnasoft/kengine/v2