gin

README

tao-gin

  _______             _____ _       
 |__   __|           / ____(_)      
    | | __ _  ___   | |  __ _ _ __  
    | |/ _` |/ _ \  | | |_ | | '_ \ 
    | | (_| | (_) | | |__| | | | | |
    |_|\__,_|\___/   \_____|_|_| |_|

Config your gin server!

Documentation

Index

• Constants
• Variables
• type Config
  • func (g *Config) Name() string
  • func (g *Config) RunAfter() []string
  • func (g *Config) ToTask() tao.Task
  • func (g *Config) ValidSelf()
• type Pprof

Constants

const ConfigKey = "gin"

ConfigKey for this repo

Variables

var Engine *gin.Engine

Engine of gin implements http.Handler

var G = new(Config)

G config of gin

Types

type Config

type Config struct {
	Schema       string   `json:"schema"`
	Host         string   `json:"host"`
	Port         int      `json:"port"`
	Listen       string   `json:"listen"`
	Mode         string   `json:"mode"`
	TrustProxies []string `json:"trust_proxies"`
	HTMLPattern  string   `json:"html_pattern"`
	StaticPath   string   `json:"static_path"`
	Pprof        *Pprof   `json:"pprof"`
	RunAfters    []string `json:"run_after,omitempty"`
}

Config implements tao.Config

func (*Config) Name

func (g *Config) Name() string

Name of Config

func (*Config) RunAfter

func (g *Config) RunAfter() []string

RunAfter defines pre task names

func (*Config) ToTask

func (g *Config) ToTask() tao.Task

ToTask transform itself to Task

func (*Config) ValidSelf

func (g *Config) ValidSelf()

ValidSelf with some default values

type Pprof

type Pprof struct {
	Enable bool   `json:"enable"`
	Prefix string `json:"prefix"`
}

Pprof config of gin