ikuzo

Documentation

Index

• func DefaultMiddleware() []func(http.Handler) http.Handler
• type BuildVersionInfo
  • func NewBuildVersionInfo(version, commit, buildagent, builddate string) *BuildVersionInfo
  • func (info *BuildVersionInfo) String() string
• type Option
  • func SetBuildVersionInfo(info *BuildVersionInfo) Option
  • func SetBulkService(svc *bulk.Service) Option
  • func SetDisableRequestLogger() Option
  • func SetEADService(svc *ead.Service) Option
  • func SetElasticSearchProxy(proxy *elasticsearch.Proxy) Option
  • func SetEnableLegacyConfig() Option
  • func SetImageProxyService(service *imageproxy.Service) Option
  • func SetLegacyRouters(routers ...RouterFunc) Option
  • func SetLogger(l *logger.CustomLogger) Option
  • func SetMetricsPort(port int) Option
  • func SetMiddleware(middleware ...func(next http.Handler) http.Handler) Option
  • func SetOrganisationService(service *organization.Service) Option
  • func SetPort(port int) Option
  • func SetRevisionService(service *revision.Service) Option
  • func SetRouters(rb ...RouterFunc) Option
  • func SetShutdownHook(name string, hook Shutdown) Option
  • func SetTLS(cert, key string) Option
• type RouterFunc
• type Server
  • func NewServer(options ...Option) (Server, error)
• type Service
• type Shutdown
• type WorkerService

Functions

func DefaultMiddleware

func DefaultMiddleware() []func(http.Handler) http.Handler

DefaultMiddleware are the default functions applied to the global router.

Types

type BuildVersionInfo

type BuildVersionInfo struct {
	Version    string `json:"version"`
	Commit     string `json:"commit"`
	BuildAgent string `json:"buildAgent"`
	BuildDate  string `json:"buildDate"`
	BuildID    string `json:"buildID"`
}

BuildVersionInfo holds all the version information

func NewBuildVersionInfo

func NewBuildVersionInfo(version, commit, buildagent, builddate string) *BuildVersionInfo

NewBuildVersionInfo creates a BuildVersionInfo struct

func (*BuildVersionInfo) String

func (info *BuildVersionInfo) String() string

type Option

type Option func(*server) error

Option is a closure to configure the Server. It is used in NewServer.

func SetBuildVersionInfo

func SetBuildVersionInfo(info *BuildVersionInfo) Option

func SetBulkService

func SetBulkService(svc *bulk.Service) Option

func SetDisableRequestLogger

func SetDisableRequestLogger() Option

SetDisableRequestLogger disables logging of HTTP request

func SetEADService

func SetEADService(svc *ead.Service) Option

func SetElasticSearchProxy

func SetElasticSearchProxy(proxy *elasticsearch.Proxy) Option

func SetEnableLegacyConfig

func SetEnableLegacyConfig() Option

func SetImageProxyService

func SetImageProxyService(service *imageproxy.Service) Option

func SetLegacyRouters

func SetLegacyRouters(routers ...RouterFunc) Option

func SetLogger

func SetLogger(l *logger.CustomLogger) Option

SetLogger configures the global logger for the server.

func SetMetricsPort

func SetMetricsPort(port int) Option

SetMetricsPort sets the TCP port for the metrics server.

No default. When set to 0 the metrics server is not started

func SetMiddleware

func SetMiddleware(middleware ...func(next http.Handler) http.Handler) Option

SetMiddleware configures the global middleware for the HTTP router.

func SetOrganisationService

func SetOrganisationService(service *organization.Service) Option

SetOrganisationService configures the organization service. When no service is set a default transient memory-based service is used.

func SetPort

func SetPort(port int) Option

SetPort sets the TCP port for the Server.

The Server listens on :3000 by default.

func SetRevisionService

func SetRevisionService(service *revision.Service) Option

SetRevisionService configures the organization service. When no service is set a default transient memory-based service is used.

func SetRouters

func SetRouters(rb ...RouterFunc) Option

SetRouters adds all HTTP routes for the server.

func SetShutdownHook

func SetShutdownHook(name string, hook Shutdown) Option

func SetTLS

func SetTLS(cert, key string) Option

SetTLS sets the TLS key and certificate.

When both are set the server starts in TLS mode.

type RouterFunc

type RouterFunc func(router chi.Router)

RouterFunc is a callback that registers routes to the ikuzo.Server.

type Server

type Server interface {
	ListenAndServe() error
	ServeHTTP(w http.ResponseWriter, r *http.Request)
}

Server provides a net/http compliant WebServer.

func NewServer

func NewServer(options ...Option) (Server, error)

NewServer returns the default server. The configuration can be modified using Option functions. All services are lazy-loaded.

type Service

type Service interface {
	Metrics() interface{}
	http.Handler
	Shutdown
}

type Shutdown

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

Shutdown must be implement by each service that uses background services or connections.

type WorkerService

type WorkerService interface {
	Start(ctx context.Context, wg *sync.WaitGroup)
	Shutdown
}

WorkerService is the interface for background processes. The service needs to gracefully shutdown all goroutines when the context is canceled.