shared

Documentation

Index

• type FacadeHandler
• type GroupHandler
• type UpgradeableHttpServerHandler

Types

type FacadeHandler

type FacadeHandler interface {
	RestApiInterface() string
	PprofEnabled() bool
	IsInterfaceNil() bool
}

FacadeHandler defines all the methods that a facade should implement

type GroupHandler

type GroupHandler interface {
	UpdateFacade(newFacade FacadeHandler) error
	RegisterRoutes(
		ws *gin.RouterGroup,
		apiConfig config.ApiRoutesConfig,
	)
	IsAuthenticationNeeded() bool
	IsInterfaceNil() bool
}

GroupHandler defines the actions needed to be performed by an gin API group

type UpgradeableHttpServerHandler

type UpgradeableHttpServerHandler interface {
	StartHttpServer() error
	UpdateFacade(facade FacadeHandler) error
	Close() error
	IsInterfaceNil() bool
}

UpgradeableHttpServerHandler defines the actions that an upgradeable http server need to do