Documentation
¶
Overview ¶
Package quick is the quick start entry for the orb framework.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrRequiredOption = errors.New("required option not given")
ErrRequiredOption is returned when an required option haven't been given.
Functions ¶
This section is empty.
Types ¶
type Options ¶
type Options struct {
ServiceName string
Version string
Address string
Name string
Description string
Usage string
ConfigURLs []string
RegisterTTL int
RegisterInterval int
Metadata map[string]string
// Before and After funcs
Actions []HookFunc
BeforeStart []HookFunc
BeforeStop []HookFunc
AfterStart []HookFunc
AfterStop []HookFunc
}
Options for orb service.
func NewOptions ¶
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
Service is an interface that wraps the lower level components within orb. Its a convenience method for building and initializing services.
func NewService ¶
func ProvideService ¶
func ProvideService( opts *Option, logger log.Logger, registry registry.Registry, ) (*Service, error)
ProvideService provides a service with components.
Click to show internal directories.
Click to hide internal directories.