freefishgo

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

type Config struct {
	AppName    string
	RunMode    string
	ServerName string
	// EnableGzip 是否开启Gzip压缩
	EnableGzip bool
	// EnableSession 是否启用Session
	EnableSession bool
	// SessionAliveTime Session的存在时间
	SessionAliveTime time.Duration
	// MaxResponseCacheLen 响应数据最大缓存长度
	MaxResponseCacheLen int
	// SessionCookieName Session的客户端Cookie名字
	SessionCookieName string
	// RecoverPanic 是否在管道最末端捕获Panic，以取代框架的处理Panic函数
	RecoverPanic bool
	// RecoverFunc 捕获Panic的处理函数
	RecoverFunc func(ctx *HttpContext)
	Listen      Listen
}

type HttpContext struct {
	Response IResponse
	Request  *Request
}

type HttpMethod string

type IMiddleware interface {
	// Middleware 中间件的逻辑处理函数 框架会调用
	Middleware(ctx *HttpContext, next Next) *HttpContext
	// LastInit 注册框架后 框架会自动调用这个函数
	LastInit(*Config)
}

type IResponse interface {
	// WebSocket 升级为WebSocket服务 upgrades为空时采用默认的参数 为多个时只采用第一个作为WebSocket参数
	WebSocket(upgrades ...*websocket.Upgrader) (conn *websocket.Conn, err error)
	Hijack() (net.Conn, *bufio.ReadWriter, error)

	// RemoveSession 移除Session
	RemoveSession()
	// GetSession 获取指定key的session值
	GetSession(key string) (interface{}, error)

	// UpdateSession 更新session值
	UpdateSession() error
	// SetSession 设置session值
	SetSession(key string, val interface{}) error
	// SetCookie 设置Cookie
	SetCookie(c *http.Cookie)
	// SetCookieUseKeyValue 设置Cookie
	SetCookieUseKeyValue(key string, val string)
	// RemoveCookieByName 通过cookie名字移除Cookie
	RemoveCookieByName(name string)
	// WriteHeader 设置响应状态值
	WriteHeader(statusCode int)
	// ReadStatusCode 读取响应状态值
	ReadStatusCode() int
	// RemoveCookie 通过cookie移除Cookie
	RemoveCookie(ck *http.Cookie)
	// Write 写入前端的数据
	Write(b []byte) (int, error)
	// GetWriteCache 获取写入前端的缓存
	GetWriteCache() []byte
	// ClearWriteCache 清除写入前端的缓存
	ClearWriteCache()
	// WriteJson 写入前端的json数据
	WriteJson(i interface{}) error
	// Redirect 重定向路径
	Redirect(redirectPath string)

	// GetStarted 是否已经向前端写入数据了，默认是开启的，且GetMaxResponseCacheLen()设置很小
	GetStarted() bool
	// GetIsWriteInCache 获取当前请求是否临时缓存数据进入缓存中
	GetIsWriteInCache() bool
	// SetIsWriteInCache 设置是否延迟把写入前端的数据写入前端，即使设置了延迟写入前端，
	// 但当数据长度超过了配置文件设置的 MaxResponseCacheLen是依然会写入前端，
	// 判断是否已经写入前端 调用 GetStarted()进行判断
	SetIsWriteInCache(bool)
	Header() http.Header
	// GetMaxResponseCacheLen 查看延迟写入前端的数据的最大值
	GetMaxResponseCacheLen() int
	// SetMaxResponseCacheLen 设置延迟写入前端的数据的最大值，GetIsWriteInCache()为True时生效
	SetMaxResponseCacheLen(int)
	// GetMsgData 获取传送数据
	GetMsgData() map[string]interface{}
	// SetMsgData 设置传送数据
	SetMsgData(map[string]interface{})
	// Stack 500 错误的堆栈信息,其他状态为空
	Stack() string
	// Error 500 错误的信息,其他状态为空
	Error() interface{}
	SetStack(string)
	SetError(interface{})
	// contains filtered or unexported methods
}

type ISession interface {
	// Init 初始化接口
	Init(SessionAliveTime time.Duration) error
	// GetSession 获取指定sessionID的值
	GetSession(sessionID string) (map[interface{}]interface{}, error)
	// GetSessionKeyValue 创建一个sessionID
	GetSessionKeyValue() (string, error)
	// SetSession 设置sessionID的值
	SetSession(sessionID string, m map[interface{}]interface{}) error
	// RemoveBySessionID 移除sessionID及其值
	RemoveBySessionID(sessionID string) error
}

type Listen struct {
	// ServerTimeOut 服务超时时间
	ServerTimeOut time.Duration
	// WriteTimeout 写超时时间
	WriteTimeout time.Duration

	MaxHeaderBytes int
	// EnableHTTP 是否开启http服务
	EnableHTTP bool
	// HTTPAddr http服务运行ip地址
	HTTPAddr string
	// HTTPPort http服务运行端口
	HTTPPort int
	// EnableHTTPS 是否开启Https服务
	EnableHTTPS bool
	// HTTPSAddr https服务运行ip地址
	HTTPSAddr string
	// HTTPSPort https服务运行端口
	HTTPSPort int
	// HTTPSCertFile httpsCertFile文件地址
	HTTPSCertFile string
	// HTTPSKeyFile HTTPSKeyFile文件地址
	HTTPSKeyFile string
}

type Next func(*HttpContext) *HttpContext

type Request struct {
	*http.Request
}

type Response struct {
	http.ResponseWriter

	// 是否调用过Write
	Started bool

	Gzip       *gzip.Writer
	IsOpenGzip bool

	SessionId         string
	SessionCookieName string
	SessionAliveTime  time.Duration
	// contains filtered or unexported fields
}

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

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