app

Documentation

Index

• func InstallJobAPI(router *gin.Engine, db *gorm.DB)
• func NewApp(appName string) *app.App
• func NewJobServer(addr string, db *gorm.DB, opts ...Option) *nightwatch.RESTServer
• func Run(cfg *nightwatch.Config, stopCh <-chan struct{}) error
• type Option
  • func WithStopChannel(stopCh <-chan struct{}) Option
  • func WithTLSOptions(tlsOptions *genericoptions.TLSOptions) Option

Functions

func InstallJobAPI

func InstallJobAPI(router *gin.Engine, db *gorm.DB)

InstallJobAPI sets up the job-related routes in the provided router.

func NewApp

func NewApp(appName string) *app.App

NewApp creates an App object with default parameters and configurations.

func NewJobServer

func NewJobServer(addr string, db *gorm.DB, opts ...Option) *nightwatch.RESTServer

NewJobServer creates a new instance of the job server with the specified options.

func Run

func Run(cfg *nightwatch.Config, stopCh <-chan struct{}) error

Run starts the specified APIServer. This function should never exit.

Types

type Option

type Option func(jrs *jobServer)

Option is a function that configures the jobServer.

func WithStopChannel

func WithStopChannel(stopCh <-chan struct{}) Option

WithStopChannel sets the stop channel for graceful shutdown.

func WithTLSOptions

func WithTLSOptions(tlsOptions *genericoptions.TLSOptions) Option

WithTLSOptions sets the TLS options for the job REST server.