package
0.0.0-20241213121623-605c1412b9b3
Repository: https://github.com/cilium/hive.git
Documentation: pkg.go.dev
# Functions
Config constructs a new config cell.
Decorate takes a decorator function and a set of cells and returns a decorator cell.
DecorateAll takes a decorator function and applies the decoration globally.
Group a set of cells.
Invoke constructs a cell for invoke functions.
Module creates a scoped set of cells with a given identifier.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Provide constructs a new cell with the given constructors.
ProvidePrivate is like Provide, but the constructed objects are only available within the module it is defined and nested modules.
SimpleHealthCmd for showing or checking the simple module health state.
# Constants
StatusDegraded is the status of a Module that has entered a degraded state.
StatusOK is the status of a Module that has achieved a desired state.
StatusStopped is the status of a Module that has completed, further updates will not be processed.
StatusUnknown is the default status of a Module, prior to it reporting any status.
# Variables
No description provided by the author
# Structs
DefaultLifecycle lifecycle implements a simple lifecycle management that conforms to Lifecycle.
Hook is a pair of start and stop callbacks.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Interfaces
Cell is the modular building block of the hive.
Flagger is implemented by configuration structs to provide configuration for a cell.
Health provides a method of declaring a Modules health status.
HookInterface wraps the Start and Stop methods that can be appended to an application lifecycle.
Info provides a simple way of printing cells hierarchically in textual form.
No description provided by the author
Lifecycle enables cells to register start and stop hooks, either from a constructor or an invoke function.
# Type aliases
No description provided by the author
No description provided by the author
FullModuleID is the fully qualified module identifier, e.g.
HookContext is a context passed to a lifecycle hook that is cancelled in case of timeout.
In when embedded into a struct used as constructor parameter makes the exported values of that struct become dependency injected values.
No description provided by the author
Level denotes what kind an update is.
ModuleDecorator is the optional decorator function used for each module to provide or replace objects in each module's scope.
No description provided by the author
ModuleID is the module identifier.
No description provided by the author
No description provided by the author
Out when embedded into a struct that is returned by a constructor will make the values in the struct become objects in the dependency graph instead of the struct itself.