treemanager

Documentation

Index

• Constants
• Variables
• func NewServer(logger *zap.Logger, db *sql.DB, opts ...Option) *common.Server
• type Option
  • func WithAuditMiddleware(auditMiddleware *ginaudit.Middleware) Option
  • func WithAuthConfig(config *ginjwt.AuthConfig) Option
  • func WithDebug(debug bool) Option
  • func WithListen(listen string) Option
  • func WithNotifier(n notifier.Notifier) Option
  • func WithShutdownTimeout(t time.Duration) Option
  • func WithStorageDriver(d storage.DirectoryAdmin) Option
  • func WithUnix(unix string) Option

Constants

const (
	// DefaultTreeManagerListen is the default listen address for the TreeManager.
	DefaultTreeManagerListen = ":8080"
	// DefaultTreeManagerUnix is the default unix socket for the TreeManager.
	DefaultTreeManagerUnix = ""
	// DefaultTreeManagerDebug is the default debug flag for the TreeManager.
	DefaultTreeManagerDebug = false
	// DefaultTreeManagerShutdownTimeout is the default shutdown timeout for the TreeManager.
	DefaultTreeManagerShutdownTimeout = 5 * time.Second
)

Variables

var DefaultTreeManagerNotifier = noop.NewNotifier()

DefaultTreeManagerNotifier is the default notifier for the TreeManager.

Functions

func NewServer

func NewServer(
	logger *zap.Logger,
	db *sql.DB,
	opts ...Option,
) *common.Server

Types

type Option

type Option func(*treeManagerConfig)

func WithAuditMiddleware

func WithAuditMiddleware(auditMiddleware *ginaudit.Middleware) Option

func WithAuthConfig

func WithAuthConfig(config *ginjwt.AuthConfig) Option

WithAuthConfig sets the jwt auth config.

func WithDebug

func WithDebug(debug bool) Option

WithDebug sets the debug flag for the server.

func WithListen

func WithListen(listen string) Option

WithListen sets the listen address for the server.

func WithNotifier

func WithNotifier(n notifier.Notifier) Option

WithNotifier sets the notifier for the server.

func WithShutdownTimeout

func WithShutdownTimeout(t time.Duration) Option

WithShutdownTimeout sets the shutdown timeout for the server.

func WithStorageDriver

func WithStorageDriver(d storage.DirectoryAdmin) Option

WithStorageDriver sets the storage driver for the server.

func WithUnix

func WithUnix(unix string) Option

WithUnix sets the unix socket for the server. If set, the server will listen on the unix socket instead of the listen address.