healthcheck

Documentation

Index

• type Handler
  • func NewHandler(pubSub pubSub, vctService vctService, db db, keyManager keyManager, ...) *Handler
  • func (h *Handler) Handler() common.HTTPRequestHandler
  • func (h *Handler) Method() string
  • func (h *Handler) Path() string

Types

type Handler

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

Handler implements a health check HTTP handler.

func NewHandler

func NewHandler(pubSub pubSub, vctService vctService, db db, keyManager keyManager, maintenanceMode bool) *Handler

NewHandler returns a new health check handler.

func (*Handler) Handler

func (h *Handler) Handler() common.HTTPRequestHandler

Handler returns the handler that should be invoked when an HTTP POST is requested to the target endpoint. This handler must be registered with an HTTP server.

func (*Handler) Method

func (h *Handler) Method() string

Method returns the HTTP method, which is always POST.

func (*Handler) Path

func (h *Handler) Path() string

Path returns the base path of the target URL for this handler.