background

Documentation

Overview

Package background implements utilities for managing background services.

Index

• type ServiceManager
  • func NewServiceManager(logger *logging.Logger) *ServiceManager
  • func (m *ServiceManager) Cleanup()
  • func (m *ServiceManager) Register(srv service.BackgroundService)
  • func (m *ServiceManager) RegisterCleanupOnly(svc service.CleanupAble, name string)
  • func (m *ServiceManager) Stop()
  • func (m *ServiceManager) Wait()

Types

type ServiceManager

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

ServiceManager manages a group of background services.

func NewServiceManager

func NewServiceManager(logger *logging.Logger) *ServiceManager

NewServiceManager creates a new ServiceManager with the provided logger.

func (*ServiceManager) Cleanup

func (m *ServiceManager) Cleanup()

Cleanup cleans up after all registered services.

func (*ServiceManager) Register

func (m *ServiceManager) Register(srv service.BackgroundService)

Register registers a background service.

func (*ServiceManager) RegisterCleanupOnly

func (m *ServiceManager) RegisterCleanupOnly(svc service.CleanupAble, name string)

RegisterCleanupOnly registers a cleanup only background service.

func (*ServiceManager) Stop

func (m *ServiceManager) Stop()

Stop stops all services.

func (*ServiceManager) Wait

func (m *ServiceManager) Wait()

Wait waits for interruption via Stop, SIGINT, SIGTERM, or any of the registered services to terminate, and stops all services.