controllers

Documentation

Index

• Constants
• Variables
• func Register(router gin.IRouter, root string, endpoints HandlerMap) *gin.RouterGroup
• func SupplyController(c Controller) fx.Option
• type Controller
• type DelayInjectorController
  • func (cc *DelayInjectorController) DeleteDelay(c *gin.Context)
  • func (cc *DelayInjectorController) GetDelay(c *gin.Context)
  • func (cc *DelayInjectorController) PutDelay(c *gin.Context)
  • func (cc *DelayInjectorController) Register(router gin.IRouter) error
• type FaultInjectorController
  • func (f *FaultInjectorController) AddDescriptor(c *gin.Context)
  • func (f *FaultInjectorController) GetDescriptors(c *gin.Context)
  • func (f *FaultInjectorController) Register(router gin.IRouter) error
• type HandlerMap
• type KillController
  • func (k *KillController) HandleKill(c *gin.Context)
  • func (k *KillController) HandleShutdown(c *gin.Context)
  • func (k *KillController) Register(router gin.IRouter) error
• type LogController
  • func (*LogController) GetLevels(c *gin.Context)
  • func (lc *LogController) Register(router gin.IRouter) error
  • func (lc *LogController) SetComponentLevel(c *gin.Context)
• type UptimeController
  • func (u *UptimeController) Handle(c *gin.Context)
  • func (u *UptimeController) HandleSlow(c *gin.Context)
  • func (u *UptimeController) Register(router gin.IRouter) error

Constants

const ControllersTag = `group:"controllers"`

const MethodAny = "any"

MethodAny is a special value to pass for the Method key in a HandlerMap to call RouterGroup.Any instead of RouterGroup.METHOD. It is chosen so that it cannot overlap with any valid HTTP method.

Variables

var Module = fx.Module(
	"controllers",

	fx.Provide(fx.Annotate(
		func(readies []services.ReadyCheck) *UptimeController {
			return &UptimeController{readies: readies}
		},
		fx.ParamTags(services.ReadyTag),
		fx.As(new(Controller)),
		fx.ResultTags(ControllersTag),
	)),
	SupplyController(&LogController{}),
	fx.Provide(fx.Annotate(
		func(shutdowner fx.Shutdowner) *KillController {
			return &KillController{shutdowner: shutdowner}
		},
		fx.As(new(Controller)),
		fx.ResultTags(ControllersTag),
	)),

	SupplyController(&DelayInjectorController{}),
	fx.Provide(fx.Annotate(
		func(faults *faults.Set) *FaultInjectorController {
			return &FaultInjectorController{
				faults: faults,
			}
		},
		fx.As(new(Controller)),
		fx.ResultTags(ControllersTag),
	)),
)

Functions

func Register

func Register(router gin.IRouter, root string, endpoints HandlerMap) *gin.RouterGroup

RegisterMap is a helper for making many calls to RouterGroup.METHOD(...), using a table-driven approach. As a special case, if the Method in a map entry is "any", it will call RouterGroup.Any instead of a method-specific handler. As another special case, `nil` handlers will be replaced with a default handler that returns HTTP 501 Not Implemented.

func SupplyController

func SupplyController(c Controller) fx.Option

Types

type Controller

type Controller interface {
	Register(gin.IRouter) error
}

Controller defines the interface for a controller that can register its routes against a (gin) router.

type DelayInjectorController

type DelayInjectorController struct {
	// contains filtered or unexported fields
}

func (*DelayInjectorController) DeleteDelay

func (cc *DelayInjectorController) DeleteDelay(c *gin.Context)

func (*DelayInjectorController) GetDelay

func (cc *DelayInjectorController) GetDelay(c *gin.Context)

func (*DelayInjectorController) PutDelay

func (cc *DelayInjectorController) PutDelay(c *gin.Context)

func (*DelayInjectorController) Register

func (cc *DelayInjectorController) Register(router gin.IRouter) error

type FaultInjectorController

type FaultInjectorController struct {
	// contains filtered or unexported fields
}

func (*FaultInjectorController) AddDescriptor

func (f *FaultInjectorController) AddDescriptor(c *gin.Context)

func (*FaultInjectorController) GetDescriptors

func (f *FaultInjectorController) GetDescriptors(c *gin.Context)

func (*FaultInjectorController) Register

func (f *FaultInjectorController) Register(router gin.IRouter) error

type HandlerMap

type HandlerMap = map[struct{ Method, Path string }]gin.HandlerFunc

HandlerMap defines a mapping from pairs of (method, path) to a handler function for a route. It is used in RegisterMap for a controller to add its routes in a table-driven format.

type KillController

type KillController struct {
	// contains filtered or unexported fields
}

func (*KillController) HandleKill

func (k *KillController) HandleKill(c *gin.Context)

func (*KillController) HandleShutdown

func (k *KillController) HandleShutdown(c *gin.Context)

func (*KillController) Register

func (k *KillController) Register(router gin.IRouter) error

type LogController

type LogController struct {
}

func (*LogController) GetLevels

func (*LogController) GetLevels(c *gin.Context)

func (*LogController) Register

func (lc *LogController) Register(router gin.IRouter) error

func (*LogController) SetComponentLevel

func (lc *LogController) SetComponentLevel(c *gin.Context)

type UptimeController

type UptimeController struct {
	// contains filtered or unexported fields
}

func (*UptimeController) Handle

func (u *UptimeController) Handle(c *gin.Context)

func (*UptimeController) HandleSlow

func (u *UptimeController) HandleSlow(c *gin.Context)

func (*UptimeController) Register

func (u *UptimeController) Register(router gin.IRouter) error