Documentation
¶
Index ¶
- func Daemonize(manager SystemManager, f DaemonFunction, name string)
- func GracefulShutdown(ctx context.Context, killFunc func())
- type DaemonFunction
- type ManagerOption
- type MockSystemManager
- func (m *MockSystemManager) AddPreShutdownHook(hook PreShutdownHook)
- func (m *MockSystemManager) AddShutdownHook(hook ShutdownHook)
- func (m *MockSystemManager) Context() context.Context
- func (m *MockSystemManager) Logger() *zap.Logger
- func (m *MockSystemManager) ServiceContext() context.Context
- func (m *MockSystemManager) ServiceWaitGroup() *sync.WaitGroup
- func (m *MockSystemManager) Shutdown()
- func (m *MockSystemManager) State() ServiceState
- func (m *MockSystemManager) Tracer() opentracing.Tracer
- func (m *MockSystemManager) WaitForInterrupt()
- type Params
- type PreShutdownHook
- type ServiceState
- type ShutdownFunction
- type ShutdownHook
- type SystemManager
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Daemonize ¶
func Daemonize(manager SystemManager, f DaemonFunction, name string)
func GracefulShutdown ¶
GracefulShutdown sets up a shutdown handler that calls killFunc when the process needs to clean up and terminate. killFunc will be executed at most once.
Types ¶
type DaemonFunction ¶
type DaemonFunction func(ctx context.Context) (ShutdownFunction, chan error)
type ManagerOption ¶
type ManagerOption func(*managerOpts)
ManagerOption allows the manager to be customized via options.
func WithContext ¶
func WithContext(ctx context.Context) ManagerOption
WithContext allows to set root context instead of using context.Background() by default
func WithLogSampling ¶
func WithLogSampling(sampling *zap.SamplingConfig) ManagerOption
WithLogSampling will enable sampling on the default logger if you didn't provide one yourself. This option will have no effect if used with the WithLogger option.
func WithLogger ¶
func WithLogger(logger *zap.Logger) ManagerOption
WithLogger allows the logger to be injected into the manager.
type MockSystemManager ¶
type MockSystemManager struct {
GContext context.Context
GLogger *zap.Logger
GTracer opentracing.Tracer
GServiceContext context.Context
GServiceWaitGroup *sync.WaitGroup
GShutdownHooks []ShutdownHook
GPreShutdownHooks []PreShutdownHook
}
func (*MockSystemManager) AddPreShutdownHook ¶
func (m *MockSystemManager) AddPreShutdownHook(hook PreShutdownHook)
func (*MockSystemManager) AddShutdownHook ¶
func (m *MockSystemManager) AddShutdownHook(hook ShutdownHook)
func (*MockSystemManager) Context ¶
func (m *MockSystemManager) Context() context.Context
func (*MockSystemManager) Logger ¶
func (m *MockSystemManager) Logger() *zap.Logger
func (*MockSystemManager) ServiceContext ¶
func (m *MockSystemManager) ServiceContext() context.Context
func (*MockSystemManager) ServiceWaitGroup ¶
func (m *MockSystemManager) ServiceWaitGroup() *sync.WaitGroup
func (*MockSystemManager) Shutdown ¶
func (m *MockSystemManager) Shutdown()
func (*MockSystemManager) State ¶
func (m *MockSystemManager) State() ServiceState
func (*MockSystemManager) Tracer ¶
func (m *MockSystemManager) Tracer() opentracing.Tracer
func (*MockSystemManager) WaitForInterrupt ¶
func (m *MockSystemManager) WaitForInterrupt()
type Params ¶
type Params struct {
fx.In
SystemManager SystemManager `optional:"true"`
}
type PreShutdownHook ¶
type PreShutdownHook func()
type ServiceState ¶
type ServiceState int
const ( Starting ServiceState = iota + 1 Running Stopping Terminated Failed )
type ShutdownFunction ¶
type ShutdownHook ¶
type ShutdownHook func()
type SystemManager ¶
type SystemManager interface {
Context() context.Context
Logger() *zap.Logger
Tracer() opentracing.Tracer
ServiceContext() context.Context
ServiceWaitGroup() *sync.WaitGroup
State() ServiceState
AddPreShutdownHook(PreShutdownHook)
AddShutdownHook(ShutdownHook)
WaitForInterrupt()
Shutdown()
}
func NewManager ¶
func NewManager(opts ...ManagerOption) SystemManager
NewManager creates a new system manager.
func NewMockSystemManager ¶
func NewMockSystemManager() SystemManager
Source Files
Click to show internal directories.
Click to hide internal directories.