baseapp

Documentation

Index

• type BaseApp
  • func New(appConfig ServerConfig, logger log.Log, notifier notifier.Notifier) *BaseApp
  • func (b *BaseApp) GetConfig() ServerConfig
  • func (b *BaseApp) GetContextWithCorrelation(ctx context.Context, c *log.CorrelationParam) context.Context
  • func (b *BaseApp) GetContextWithCustomerId(ctx context.Context, c *log.CustomerIdentifier) context.Context
  • func (b *BaseApp) GetLogger() log.Log
  • func (b *BaseApp) GetNotifier() notifier.Notifier
  • func (b *BaseApp) PanicRecovery(ctx context.Context, rec any) (string, error)
  • func (b *BaseApp) ProcessError(ctx context.Context, stackTrace string, err error) (int, []byte)
  • func (b *BaseApp) RegisterHealthCheckHook(handler HealthCheckHook)
  • func (b *BaseApp) RegisterHooks(hook any)
  • func (b *BaseApp) RegisterOnShutdownHook(handler ShutdownHook)
  • func (b *BaseApp) RegisterStatusCheckHook(handler StatusCheckHook)
  • func (b *BaseApp) RunHealthCheck(ctx context.Context) error
  • func (b *BaseApp) RunStatusCheck(ctx context.Context) map[string]any
  • func (b *BaseApp) SetNotifier(notifier notifier.Notifier)
  • func (b *BaseApp) Shutdown(ctx context.Context)
  • func (b *BaseApp) StartSignalMonitor(ctx context.Context) error
  • func (b *BaseApp) WaitForCompleteShutDown()
• type HealthCheckHook
• type ServerConfig
• type ShutdownHook
• type StatusCheckHook

Types

type BaseApp

type BaseApp struct {
	// contains filtered or unexported fields
}

func New

func New(appConfig ServerConfig, logger log.Log, notifier notifier.Notifier) *BaseApp

func (*BaseApp) GetConfig

func (b *BaseApp) GetConfig() ServerConfig

func (*BaseApp) GetContextWithCorrelation

func (b *BaseApp) GetContextWithCorrelation(ctx context.Context, c *log.CorrelationParam) context.Context

func (*BaseApp) GetContextWithCustomerId

func (b *BaseApp) GetContextWithCustomerId(ctx context.Context, c *log.CustomerIdentifier) context.Context

func (*BaseApp) GetLogger

func (b *BaseApp) GetLogger() log.Log

func (*BaseApp) GetNotifier

func (b *BaseApp) GetNotifier() notifier.Notifier

func (*BaseApp) PanicRecovery

func (b *BaseApp) PanicRecovery(ctx context.Context, rec any) (string, error)

func (*BaseApp) ProcessError

func (b *BaseApp) ProcessError(ctx context.Context, stackTrace string, err error) (int, []byte)

func (*BaseApp) RegisterHealthCheckHook

func (b *BaseApp) RegisterHealthCheckHook(handler HealthCheckHook)

func (*BaseApp) RegisterHooks

func (b *BaseApp) RegisterHooks(hook any)

func (*BaseApp) RegisterOnShutdownHook

func (b *BaseApp) RegisterOnShutdownHook(handler ShutdownHook)

func (*BaseApp) RegisterStatusCheckHook

func (b *BaseApp) RegisterStatusCheckHook(handler StatusCheckHook)

func (*BaseApp) RunHealthCheck

func (b *BaseApp) RunHealthCheck(ctx context.Context) error

func (*BaseApp) RunStatusCheck

func (b *BaseApp) RunStatusCheck(ctx context.Context) map[string]any

func (*BaseApp) SetNotifier

func (b *BaseApp) SetNotifier(notifier notifier.Notifier)

func (*BaseApp) Shutdown

func (b *BaseApp) Shutdown(ctx context.Context)

func (*BaseApp) StartSignalMonitor

func (b *BaseApp) StartSignalMonitor(ctx context.Context) error

func (*BaseApp) WaitForCompleteShutDown

func (b *BaseApp) WaitForCompleteShutDown()

type HealthCheckHook

type HealthCheckHook interface {
	Name(ctx context.Context) string
	HealthCheck(ctx context.Context) error
}

type ServerConfig

type ServerConfig struct {
	ServiceName string
}

type ShutdownHook

type ShutdownHook interface {
	Name(ctx context.Context) string
	Shutdown(ctx context.Context) error
}

type StatusCheckHook

type StatusCheckHook interface {
	Name(ctx context.Context) string
	StatusCheck(ctx context.Context) (any, error)
}