http

Documentation

Index

• type Config
• type EndpointsRegistrar
• type Router
  • func NewRouter(cfg Config) *Router
  • func (r *Router) Init(_ context.Context) error
  • func (r *Router) PostConstruct()
  • func (r *Router) Shutdown()

Types

type Config

type Config struct {
	// HttpAddr specifies the address to listen incoming HTTP connections
	HttpAddr string // could be empty
	// HttpPort specifies the listening port for the incoming HTTP connections
	HttpPort int
	// RestRegistrar is the endpoints registrar
	RestRegistrar EndpointsRegistrar
}

Config provides the Http router configuration

type EndpointsRegistrar

type EndpointsRegistrar func(*gin.Engine) error

EndpointsRegistrar is a component which provides a callback for registering REST endpoints in the Router server

type Router

type Router struct {
	linker.PostConstructor
	linker.Initializer
	linker.Shutdowner
	// contains filtered or unexported fields
}

Router service manages http endpoints

func NewRouter

func NewRouter(cfg Config) *Router

NewRouter creates new Router instance

func (*Router) Init

func (r *Router) Init(_ context.Context) error

Init implements linker.Initializer

func (*Router) PostConstruct

func (r *Router) PostConstruct()

PostConstruct implements linker.PostConstructor

func (*Router) Shutdown

func (r *Router) Shutdown()

Shutdown implements linker.Shutdowner