Documentation ¶
Index ¶
- func NewCacheStore(cachePrefix string) *cacheStore
- type HttpComponent
- type HttpComponentConfig
- type HttpContext
- func (ctx *HttpContext) Close()
- func (ctx *HttpContext) CloseHandler(handler func())
- func (ctx *HttpContext) DelCookie(name string)
- func (ctx *HttpContext) GetCookie(name string) *http.Cookie
- func (ctx *HttpContext) GetCookieValue(name string) string
- func (ctx *HttpContext) GetHttpRequest() *http.Request
- func (ctx *HttpContext) GetHttpResponseWriter() http.ResponseWriter
- func (ctx *HttpContext) SetCookie(cookie *http.Cookie)
- func (ctx *HttpContext) SetCookieValue(name string, value string)
- func (ctx *HttpContext) SetHttpRequest(request *http.Request)
- func (ctx *HttpContext) SetHttpResponseWriter(responseWriter http.ResponseWriter)
- type HttpController
- type HttpControllerInterface
- type HttpSession
- type HttpSessionInterface
- type SessionOption
- type SessionStoreManager
- type Store
- type UploadFile
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewCacheStore ¶ added in v0.4.3
func NewCacheStore(cachePrefix string) *cacheStore
Types ¶
type HttpComponent ¶
type HttpComponent struct { component.Component camRouter.RouterPlugin camContext.ContextPlugin camMiddleware.MiddlewarePlugin // contains filtered or unexported fields }
http server component
func (*HttpComponent) Init ¶
func (comp *HttpComponent) Init(configI camBase.ComponentConfigInterface)
init
type HttpComponentConfig ¶
type HttpComponentConfig struct { component.ComponentConfig camRouter.RouterPluginConfig camContext.ContextPluginConfig camSsl.SslPluginConfig camMiddleware.MiddlewarePluginConfig Port uint16 // Deprecated: remove on v0.6.0 SessionName string // Deprecated: remove on v0.6.0 SessionKey string // contains filtered or unexported fields }
http server config
func NewHttpComponentConfig ¶
func NewHttpComponentConfig(port uint16) *HttpComponentConfig
new config
func (*HttpComponentConfig) AddRoute ¶
func (conf *HttpComponentConfig) AddRoute(route string, handler camBase.HttpRouteHandler)
add custom route handler. its priority is higher than the controller. Deprecated: remove on v0.5.0 It's not support middleware Instead: HttpComponentConfig.MiddlewarePluginConfig.AddRoute()
func (*HttpComponentConfig) SetSessionOption ¶ added in v0.4.3
func (conf *HttpComponentConfig) SetSessionOption(opt *SessionOption)
func (*HttpComponentConfig) SetSessionStore ¶ added in v0.4.3
func (conf *HttpComponentConfig) SetSessionStore(store Store)
type HttpContext ¶ added in v0.4.1
type HttpContext struct { camContext.Context // contains filtered or unexported fields }
func (*HttpContext) Close ¶ added in v0.4.1
func (ctx *HttpContext) Close()
func (*HttpContext) CloseHandler ¶ added in v0.4.1
func (ctx *HttpContext) CloseHandler(handler func())
func (*HttpContext) DelCookie ¶ added in v0.4.3
func (ctx *HttpContext) DelCookie(name string)
func (*HttpContext) GetCookie ¶ added in v0.4.3
func (ctx *HttpContext) GetCookie(name string) *http.Cookie
func (*HttpContext) GetCookieValue ¶ added in v0.4.3
func (ctx *HttpContext) GetCookieValue(name string) string
func (*HttpContext) GetHttpRequest ¶ added in v0.4.1
func (ctx *HttpContext) GetHttpRequest() *http.Request
func (*HttpContext) GetHttpResponseWriter ¶ added in v0.4.1
func (ctx *HttpContext) GetHttpResponseWriter() http.ResponseWriter
func (*HttpContext) SetCookie ¶ added in v0.4.3
func (ctx *HttpContext) SetCookie(cookie *http.Cookie)
func (*HttpContext) SetCookieValue ¶ added in v0.4.3
func (ctx *HttpContext) SetCookieValue(name string, value string)
func (*HttpContext) SetHttpRequest ¶ added in v0.4.1
func (ctx *HttpContext) SetHttpRequest(request *http.Request)
func (*HttpContext) SetHttpResponseWriter ¶ added in v0.4.1
func (ctx *HttpContext) SetHttpResponseWriter(responseWriter http.ResponseWriter)
type HttpController ¶
type HttpController struct { camRouter.Controller // contains filtered or unexported fields }
http controller
func (*HttpController) GetFile ¶
func (ctrl *HttpController) GetFile(key string) *UploadFile
Get upload file call UploadFile.Save(...) if you want to save the upload file
func (*HttpController) GetHttpContext ¶ added in v0.4.1
func (ctrl *HttpController) GetHttpContext() camBase.HttpContextInterface
Get HttpContextInterface
func (*HttpController) GetRequest
deprecated
func (ctrl *HttpController) GetRequest() *http.Request
Deprecated: remove on v0.5.0 Instead: Please use context to implement camBase.ContextHttpInterface
func (*HttpController) GetRequestWriter
deprecated
func (ctrl *HttpController) GetRequestWriter() *http.ResponseWriter
Deprecated: remove on v0.5.0 Instead: Please use context to implement camBase.ContextHttpInterface
type HttpControllerInterface ¶
type HttpControllerInterface interface {
// contains filtered or unexported methods
}
http controller interface Deprecated: remove on v0.5.0
type HttpSession ¶
type HttpSession struct { camBase.SessionInterface // contains filtered or unexported fields }
session
func (*HttpSession) Values ¶ added in v0.4.3
func (sess *HttpSession) Values() map[string]interface{}
type HttpSessionInterface ¶ added in v0.4.3
type HttpSessionInterface 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) // get all values in session Values() map[string]interface{} // destroy session Destroy() }
type SessionOption ¶ added in v0.4.3
type SessionStoreManager ¶ added in v0.4.3
type SessionStoreManager struct {
// contains filtered or unexported fields
}
func NewSessionStoreManager ¶ added in v0.4.3
func NewSessionStoreManager(store Store, option *SessionOption) *SessionStoreManager
func (*SessionStoreManager) GetSession ¶ added in v0.4.3
func (m *SessionStoreManager) GetSession(ctx camBase.HttpContextInterface) (HttpSessionInterface, error)
get session or new by Context
type Store ¶ added in v0.4.3
type Store interface { SetSessionOption(opt *SessionOption) // Create one if not exists Get(sessId string) (HttpSessionInterface, error) Save(sessI HttpSessionInterface) error Del(sessI HttpSessionInterface) error }
type UploadFile ¶
type UploadFile struct { File multipart.File Header *multipart.FileHeader }
UploadFile helper
func NewUploadFile ¶
func NewUploadFile(file multipart.File, Header *multipart.FileHeader) *UploadFile
New UploadFile instance
func (*UploadFile) Save ¶
func (uf *UploadFile) Save(absFilename string) error
Save file absFilename