server

Documentation

Index

• type Component
• type Option
  • func SetComponents(in []Component) Option
  • func SetGinMiddlewares(in []gin.HandlerFunc) Option
  • func SetServerMeta(in ServerMeta) Option
• type Server
  • func New(opts ...Option) *Server
  • func (s *Server) Meta() ServerMeta
  • func (s *Server) Serve()
  • func (s *Server) SetComponent(c Component) error
• type ServerConfig
• type ServerMeta

Types

type Component

type Component interface {
	Name() string
	Meta() map[string]string
	Setup(*Server) error
}

type Option

type Option func(*ServerConfig)

func SetComponents

func SetComponents(in []Component) Option

func SetGinMiddlewares

func SetGinMiddlewares(in []gin.HandlerFunc) Option

func SetServerMeta

func SetServerMeta(in ServerMeta) Option

type Server

type Server struct {
	*gin.Engine
	// contains filtered or unexported fields
}

func New

func New(opts ...Option) *Server

func (*Server) Meta

func (s *Server) Meta() ServerMeta

func (*Server) Serve

func (s *Server) Serve()

func (*Server) SetComponent

func (s *Server) SetComponent(c Component) error

type ServerConfig

type ServerConfig struct {
	Components     []Component
	Meta           ServerMeta
	GinMiddlewares []gin.HandlerFunc
}

type ServerMeta

type ServerMeta struct {
	Name        string
	Description string
	GitHubLink  bool
}