web

type Authentication struct {
	UserID string `json:"userId"      bson:"user_id"        sql:"user_id"`

	AccessToken string `json:"accessToken" bson:"access_token"   sql:"access_token"`
	Permission  uint8  `json:"permission"  bson:"permission"     sql:"permission"`
	// contains filtered or unexported fields
}

type Client struct {
	Timeout time.Duration
	// contains filtered or unexported fields
}

type Ctx interface {
	// Context returns the internal context of this API processing
	Context() context.Context
	// ConstStringValue returns const string parameter value defined in controller
	ConstStringValue(name string) string
	// ConstIntValue returns const int parameter value defined in controller
	ConstIntValue(name string) int
	// StatusOk sets status code to 200
	StatusOk() Ctx
	// StatusCreated sets status code to 201
	StatusCreated(location string) Ctx
	// StatusAccepted sets status code to 202
	StatusAccepted() Ctx
	// StatusNonAuthoritativeInfo  sets status code to 203
	StatusNonAuthoritativeInfo() Ctx
	// StatusNoContent sets status code to 204
	StatusNoContent() Ctx
	// Error sets status code with error message (do not set 2xx/3xx)
	Error(statusCode int, msg ...interface{}) Ctx
	// StatusBadRequest sets status code to 400
	StatusBadRequest(param ...interface{}) Ctx
	// StatusUnauthorized sets status code to 401
	StatusUnauthorized() Ctx
	// StatusForbidden sets status code to 403
	StatusForbidden(msg ...interface{}) Ctx
	// StatusNotFound sets status code to 404
	StatusNotFound() Ctx
	// StatusInternalServerError sets status code to 500
	StatusInternalServerError(msg ...interface{}) Ctx
	// StatusServiceUnavailable sets status code to 503
	StatusServiceUnavailable(msg ...interface{}) Ctx
	// SetResponseValue sets/adds a pair of key-value append to response body
	SetResponseValue(key string, value interface{})
	// SysLogf writes system log
	// system logs are used for technicians to investigate warns and errors
	// no need to consider log level because log level will be automatically set
	// if no errors occurred and status code is set to 2xx/3xx, log level is info
	// if no errors occurred and status code is set to 4xx, log level is warn
	// if any errors occurred or status code is set to 5xx, log level is error
	SysLogf(format string, args ...interface{}) Ctx
	// GameLog writes game log
	// game logs are used to track user behavior history
	// game logs are for KPI analysis, customer service, etc.
	GameLog(action string, fields map[string]interface{}, args ...interface{}) Ctx
	// Assert throw a fatal error if the value of ok is not true
	Assert(ok bool, format string, args ...interface{}) Ctx
	// Cache returns reference of cache instance by id
	// cache instance with an id is defined in controllers
	Cache(id ...string) (plugin *plugins.Cache)
	// Redis returns reference of redis client by id
	// redis client with an id is defined in controllers
	Redis(id ...string) (plugin *plugins.Redis)
	// Mongo returns reference of mongodb client with default database
	// mongodb client with an id is defined in controllers
	Mongo(database ...string) (plugin *plugins.Mongo)
	// MySQL returns reference of mysql client with default database
	// mysql client with an id is defined in controllers
	MySQL(database ...string) (plugin *plugins.MySQL)
	// Sqlite returns reference of sqlite
	// sqlite with an id is defined in controllers
	Sqlite(database ...string) (plugin *plugins.Sqlite)
	// MasterTable find and returns master table by table name
	MasterTable(tableName string, mux ...string) plugins.MasterTable
	// HasError returns true if no errors occurred and status code is 2xx/3xx
	HasError() bool
	// HttpClient returns the default http client that used for server-server communication
	HttpClient() *Client
	// Now returns the time when request came
	Now() time.Time

	context.Context
	// contains filtered or unexported methods
}

type Gate struct {
	Config *GateConfig
	// contains filtered or unexported fields
}

type GateConfig struct {
	ServerConfig `yaml:",inline"`
	Gateways     []struct {
		ServerName string   `yaml:"server_name" default:""`
		LBClients  []string `yaml:"lb_clients"`
	} `yaml:"gateways"`
	Timeout time.Duration `yaml:"timeout" default:"2s"`
}

type Handler func(ctx Ctx)

type HeaderReceivedHandler func(header *fasthttp.RequestHeader) fasthttp.RequestConfig

type Middleware func(Handler) Handler

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

type ServerConfig struct {
	ID                 string        `yaml:"id" required:"true"`
	HttpVersion        string        `yaml:"http_version" default:"1.1"`
	Network            string        `yaml:"network" default:"tcp"`
	Address            string        `yaml:"address" default:":8088"`
	UseTLS             bool          `yaml:"use_tls" default:"false"`
	CertFile           string        `yaml:"cert_file"`
	KeyFile            string        `yaml:"key_file"`
	Concurrency        int           `yaml:"concurrency" default:"8192"`
	MaxConnectionPerIP int           `yaml:"max_connection_per_ip" default:"1024"`
	ReadTimeout        time.Duration `yaml:"read_timeout" default:"0"`
	WriteTimeout       time.Duration `yaml:"write_timeout" default:"0"`
	MaxRequestBodySize int           `yaml:"max_request_body_size" default:"1024"`
	CompressLevel      int           `yaml:"compress_level" default:"0"`
	HandleTimeout      time.Duration `yaml:"handle_timeout" default:"0"`
	ControllerFilepath string        `yaml:"controller_filepath" default:"controller/"`
	LogLevel           string        `yaml:"log_level" default:"info"`
}