camHttp

Documentation

Index

• type HttpComponent
  • func (comp *HttpComponent) Init(configI camBase.ComponentConfigInterface)
  • func (comp *HttpComponent) Start()
  • func (comp *HttpComponent) Stop()
• type HttpComponentConfig
  • func NewHttpComponentConfig(port uint16) *HttpComponentConfig
  • func (config *HttpComponentConfig) AddRoute(route string, handler camBase.HttpRouteHandler)
• type HttpContext
  • func (ctx *HttpContext) Close()
  • func (ctx *HttpContext) CloseHandler(handler func())
  • func (ctx *HttpContext) GetHttpRequest() *http.Request
  • func (ctx *HttpContext) GetHttpResponseWriter() http.ResponseWriter
  • func (ctx *HttpContext) SetHttpRequest(request *http.Request)
  • func (ctx *HttpContext) SetHttpResponseWriter(responseWriter http.ResponseWriter)
• type HttpController
  • func (ctrl *HttpController) GetFile(key string) *UploadFile
  • func (ctrl *HttpController) GetHttpContext() camBase.HttpContextInterface
  • func (ctrl *HttpController) GetRequest() *http.Request
  • func (ctrl *HttpController) GetRequestWriter() *http.ResponseWriter
• type HttpControllerInterface
• type HttpSession
  • func NewHttpSession(storeSession *sessions.Session) *HttpSession
  • func (sess *HttpSession) Del(key interface{})
  • func (sess *HttpSession) Destroy()
  • func (sess *HttpSession) Get(key interface{}) interface{}
  • func (sess *HttpSession) GetSessionId() string
  • func (sess *HttpSession) Set(key interface{}, value interface{})
• type UploadFile
  • func NewUploadFile(file multipart.File, Header *multipart.FileHeader) *UploadFile
  • func (uf *UploadFile) Close() error
  • func (uf *UploadFile) Extension() string
  • func (uf *UploadFile) Filename() string
  • func (uf *UploadFile) Save(absFilename string) error
  • func (uf *UploadFile) Size() int64
  • func (uf *UploadFile) Suffix() string

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

func (*HttpComponent) Start

func (comp *HttpComponent) Start()

start

func (*HttpComponent) Stop

func (comp *HttpComponent) Stop()

stop

type HttpComponentConfig

type HttpComponentConfig struct {
	component.ComponentConfig
	camRouter.RouterPluginConfig
	camContext.ContextPluginConfig
	camSsl.SslPluginConfig
	camMiddleware.MiddlewarePluginConfig

	Port        uint16
	SessionName string
	SessionKey  string
	// contains filtered or unexported fields
}

http server config

func NewHttpComponentConfig

func NewHttpComponentConfig(port uint16) *HttpComponentConfig

new config

func (*HttpComponentConfig) AddRoute

func (config *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()

type HttpContext

type HttpContext struct {
	camContext.Context
	// contains filtered or unexported fields
}

func (*HttpContext) Close

func (ctx *HttpContext) Close()

func (*HttpContext) CloseHandler

func (ctx *HttpContext) CloseHandler(handler func())

func (*HttpContext) GetHttpRequest

func (ctx *HttpContext) GetHttpRequest() *http.Request

func (*HttpContext) GetHttpResponseWriter

func (ctx *HttpContext) GetHttpResponseWriter() http.ResponseWriter

func (*HttpContext) SetHttpRequest

func (ctx *HttpContext) SetHttpRequest(request *http.Request)

func (*HttpContext) SetHttpResponseWriter

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

func (ctrl *HttpController) GetHttpContext() camBase.HttpContextInterface

Get HttpContextInterface

func (*HttpController) GetRequest

func (ctrl *HttpController) GetRequest() *http.Request

Deprecated: remove on v0.5.0 Instead: Please use context to implement camBase.ContextHttpInterface

func (*HttpController) GetRequestWriter

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 NewHttpSession

func NewHttpSession(storeSession *sessions.Session) *HttpSession

func (*HttpSession) Del

func (sess *HttpSession) Del(key interface{})

del value by key

func (*HttpSession) Destroy

func (sess *HttpSession) Destroy()

destroy session

func (*HttpSession) Get

func (sess *HttpSession) Get(key interface{}) interface{}

get value by key

func (*HttpSession) GetSessionId

func (sess *HttpSession) GetSessionId() string

set sessionId

func (*HttpSession) Set

func (sess *HttpSession) Set(key interface{}, value interface{})

set key-value

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) Close

func (uf *UploadFile) Close() error

Close io

func (*UploadFile) Extension

func (uf *UploadFile) Extension() string

file extension

func (*UploadFile) Filename

func (uf *UploadFile) Filename() string

filename

func (*UploadFile) Save

func (uf *UploadFile) Save(absFilename string) error

Save file absFilename

func (*UploadFile) Size

func (uf *UploadFile) Size() int64

file size

func (*UploadFile) Suffix

func (uf *UploadFile) Suffix() string

file suffix