web

package
v0.0.0-...-92b1827 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 14, 2021 License: GPL-3.0 Imports: 18 Imported by: 0

Documentation

Index

Constants

View Source
const ControllerName = "web"

ControllerName defines the name of the api controller used for dependency exception

Variables

View Source
var (

	// ServerPort specifies the port the web server is listening on
	ServerPort = flag.Int("server_port", 41100, "")
)

Functions

func NewController

func NewController(ctx gousu.IContext) gousu.IController

NewController creates a new preinitialized instance of Controller

Types

type Controller

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

Controller is the admin api controller

func (*Controller) Health

func (c *Controller) Health() error

Health checks if the api server has thrown unresolvable internal errors

func (*Controller) Name

func (c *Controller) Name() string

Name returns the name of the controller defined by ControllerName

func (*Controller) Start

func (c *Controller) Start() error

Start starts the api server in a new go-func

func (*Controller) Stop

func (c *Controller) Stop() error

Stop currently does nothing

type IController

type IController interface {
	gousu.IController
}

IController is the interface of the api controller

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL