route

Documentation

Index

• Variables
• func GroupRouter() http.Handler
• func ReCreateServer(cfg *Config)
• func Register(route ...externalRouter)
• func SetUIPath(path string)
• type Config
• type Cors
  • func (c Cors) Apply(r chi.Router)
• type HTTPError
  • func (e *HTTPError) Error() string
• type Log
• type LogStructured
• type LogStructuredField
• type Memory
• type Rule
• type Traffic

Variables

var (
	CtxKeyProxyName    = contextKey("proxy name")
	CtxKeyProviderName = contextKey("provider name")
	CtxKeyProxy        = contextKey("proxy")
	CtxKeyProvider     = contextKey("provider")
)

var (
	ErrUnauthorized   = newError("Unauthorized")
	ErrBadRequest     = newError("Body invalid")
	ErrForbidden      = newError("Forbidden")
	ErrNotFound       = newError("Resource not found")
	ErrRequestTimeout = newError("Timeout")
)

var (
	SwitchProxiesCallback func(sGroup string, sProxy string)
)

Functions

func GroupRouter

func GroupRouter() http.Handler

func ReCreateServer

func ReCreateServer(cfg *Config)

func Register

func Register(route ...externalRouter)

func SetUIPath

func SetUIPath(path string)

Types

type Config

type Config struct {
	Addr        string
	TLSAddr     string
	UnixAddr    string
	PipeAddr    string
	Secret      string
	Certificate string
	PrivateKey  string
	DohServer   string
	IsDebug     bool
	Cors        Cors
}

type Cors

type Cors struct {
	AllowOrigins        []string
	AllowPrivateNetwork bool
}

func (Cors) Apply

func (c Cors) Apply(r chi.Router)

type HTTPError

type HTTPError struct {
	Message string `json:"message"`
}

HTTPError is custom HTTP error for API

func (*HTTPError) Error

func (e *HTTPError) Error() string

type Log

type Log struct {
	Type    string `json:"type"`
	Payload string `json:"payload"`
}

type LogStructured

type LogStructured struct {
	Time    string               `json:"time"`
	Level   string               `json:"level"`
	Message string               `json:"message"`
	Fields  []LogStructuredField `json:"fields"`
}

type LogStructuredField

type LogStructuredField struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type Memory

type Memory struct {
	Inuse   uint64 `json:"inuse"`
	OSLimit uint64 `json:"oslimit"` // maybe we need it in the future
}

type Rule

type Rule struct {
	Type    string `json:"type"`
	Payload string `json:"payload"`
	Proxy   string `json:"proxy"`
	Size    int    `json:"size"`
}

type Traffic

type Traffic struct {
	Up   int64 `json:"up"`
	Down int64 `json:"down"`
}