camStatics

type AppConfigInterface interface {
}

type ApplicationInterface interface {
	// get Component instance by reflect
	GetComponent(v ComponentInterface) ComponentInterface
	// get Component instance by component name
	GetComponentByName(name string) ComponentInterface
	// get default db component's interface
	GetDB() DatabaseComponentInterface
	// run application
	Run()
	// stop application
	Stop()
	// add migration struct
	AddMigration(m MigrationInterface)
	// log trace
	Trace(title string, content string)
	// log debug
	Debug(title string, content string)
	// log info
	Info(title string, content string)
	// log warn
	Warn(title string, content string)
	// log error
	Error(title string, content string)
	// log fatal
	Fatal(title string, content string)
	// Add config
	AddConfig(config AppConfigInterface)
	// get value form .evn file
	GetEvn(key string) string
	// get params form camAppConfig.Config.Params
	GetParam(key string) interface{}
	// get migrate dict
	GetMigrateDict() map[string]MigrationInterface
	// get cache component
	GetCache() CacheComponentInterface
	// get mail component
	GetMail() MailComponentInterface
	// valid struct.
	Valid(v interface{}) (firstErr error, errDict map[string][]error)
	// Get grpc client conn
	// name: Component name
	GetGrpcClientConn(name string) *grpc.ClientConn
	// Before app init
	BeforeInit(handler func())
	// After app init
	AfterInit(handler func())
	// Before app start
	BeforeStart(handler func())
	// After app start
	AfterStart(handler func())
	// Before app stop
	BeforeStop(handler func())
	// After app start
	AfterStop(handler func())
}

type ApplicationStatus int

type CacheComponentInterface interface {
	// set cache storage default duration
	Set(key string, value interface{}) error
	// set cache storage custom duration
	SetDuration(key string, value interface{}, duration time.Duration) error
	// whether the key exists
	Exists(key string) bool
	// get value by key
	Get(key string) interface{}
	// delete cache
	Del(keys ...string) error
	// delete all cache
	Flush() error
}

type CamModuleType int

type ComponentConfigInterface interface {
	// new component
	NewComponent() ComponentInterface
	// get recover handler
	GetRecoverHandler() RecoverHandler
}

type ComponentInterface interface {
	// init
	Init(configInterface ComponentConfigInterface)
	// start
	Start()
	// stop
	Stop()
	// set app instance
	SetApp(app ApplicationInterface)
}

type ConsoleComponentInterface interface {
	// get database dir
	GetDatabaseDir() string
	// get xorm template dir
	GetXormTemplateDir() string
}

type ContextInterface interface {
	// set session
	SetSession(session SessionInterface)
	// get session
	GetSession() SessionInterface
	// Write returned data
	Write(res []byte)
	// Read returned data
	Read() []byte
	// Set RecoverInterface. As a error panic by last handle route of handler
	SetRecover(rec RecoverInterface)
	// Get RecoverInterface
	GetRecover() RecoverInterface
	// Set route
	SetRoute(route string)
	// Get route
	GetRoute() string
}

type ControllerActionInterface interface {
	// controller route
	Route() string
	// call action
	Call()
}

type ControllerInterface interface {
	// init
	Init()
	// before action
	BeforeAction(action ControllerActionInterface) bool
	// after action
	AfterAction(action ControllerActionInterface, response []byte) []byte
	// set context
	SetContext(context ContextInterface)
	// get context
	GetContext() ContextInterface
	// set values.
	// it will replace the original values
	SetValues(values map[string]interface{})
	// get default action
	GetDefaultActionName() string
}

type DatabaseComponentInterface interface {
	// get data source name.
	// [username[:password]@][protocol[(address)]]/dbname[?param1=value1&...&paramN=valueN]
	GetDSN() string
	// get engine
	GetEngine() *xorm.Engine
	// get xorm session
	NewSession() *xorm.Session
}

type GRpcComponentInterface interface {
	// get client conn
	Conn() *grpc.ClientConn
}

type GRpcLoadBalancingLogic int

type GrpcClientComponentInterface interface {
	GetConn() *grpc.ClientConn
}

type HttpContextInterface interface {
	ContextInterface
	SetHttpResponseWriter(responseWriter http.ResponseWriter)
	GetHttpResponseWriter() http.ResponseWriter
	SetHttpRequest(request *http.Request)
	GetHttpRequest() *http.Request
	CloseHandler(handler func())
	GetCookie(name string) *http.Cookie
	SetCookie(cookie *http.Cookie)
	DelCookie(name string)
	SetCookieValue(name string, value string)
	GetCookieValue(name string) string
	Close()
}

type HttpRouteHandler func(responseWriter http.ResponseWriter, request *http.Request)

type LogLevel uint8

type MailComponentInterface interface {
	Send(subject string, body string, to ...string) error
}

type MessageParseHandler func(message []byte) (controllerName string, actionName string, values map[string]interface{})

type MiddlewareInterface interface {
	// call when route has middleware
	Handler(ctx ContextInterface, next NextHandler) []byte
}

type MigrationInterface interface {
	// update migration
	Up()
	// recall migration
	Down()
	// get up sql list
	GetSqlList() []string
}

type MysqlColumnBuilderInterface interface {
	Unsigned() MysqlColumnBuilderInterface
	NotNull() MysqlColumnBuilderInterface
	Null() MysqlColumnBuilderInterface
	Default(value interface{}) MysqlColumnBuilderInterface
	AutoIncrement() MysqlColumnBuilderInterface
	Comment(comment string) MysqlColumnBuilderInterface
	After(name string) MysqlColumnBuilderInterface
	PrimaryKey() MysqlColumnBuilderInterface
	Index() MysqlColumnBuilderInterface
	Unique() MysqlColumnBuilderInterface
	ToSql() string
	GetKeyPartSql() string
}

type MysqlColumnType string

type MysqlKeyType string

type MysqlNullableType int

type NextHandler func() []byte

type PluginConfigInterface interface {
	Init()
}

type PluginInterface interface {
	Init(configInterface PluginConfigInterface)
}

type RecoverHandler func(rec interface{}) RecoverHandlerResult

type RecoverHandlerResult uint8

type RecoverInterface interface {
	Error() string
	GetError() error
}

type RouteHandler func(ctxI ContextInterface) []byte

type RuleInterface interface {
	// get fields of validation
	Fields() []string
	// get handlers of validation
	Handlers() []ValidHandler
}

type SessionInterface interface {
	// get sessionId
	GetSessionId() string
	// set key-value in session
	Set(key string, value interface{})
	// get value by key
	Get(key string) interface{}
	// delete value by key
	Del(key string)
	// destroy session
	Destroy()
}

type SocketConnHandler func(conn net.Conn)

type SocketRouteHandler func(conn net.Conn) []byte

type ValidHandler func(value reflect.Value) error

type ValidInterface interface {
	// get rules
	Rules() []RuleInterface
}

type ValidMode uint8

type ValidationComponentInterface interface {
	// valid struct
	Valid(v interface{}) map[string][]error
}

type WebsocketRouteHandler func(conn *websocket.Conn) []byte