Documentation ¶
Index ¶
- Constants
- Variables
- func BearerAuth(r *http.Request) (accessToken string, ok bool)
- func ContextGet(r *http.Request, key interface{}) interface{}
- func ContextSet(r *http.Request, paris ...interface{}) *http.Request
- func GetJSONRequestData(r *http.Request, data interface{}) error
- func GetJSONRequestMap(r *http.Request) map[string]interface{}
- func GetRequestVars(r *http.Request, keys ...string) map[string]string
- func Response(w http.ResponseWriter, setting ResponseSetting, filler ResponseFiller, ...)
- func ResponseJSON(w http.ResponseWriter, statusCode int, data interface{}, ...)
- func SetupWebsocket(wsc *WsConnect, w http.ResponseWriter, r *http.Request, ...) (err error)
- type JSONFiller
- type RequestVar
- func (rv RequestVar) Exist(key string) bool
- func (rv RequestVar) Get(key string) []string
- func (rv RequestVar) GetBool(key string) (bool, error)
- func (rv RequestVar) GetBools(key string) ([]bool, error)
- func (rv RequestVar) GetFloat(key string) (float64, error)
- func (rv RequestVar) GetFloats(key string) ([]float64, error)
- func (rv RequestVar) GetInt(key string) (int64, error)
- func (rv RequestVar) GetInts(key string) ([]int64, error)
- func (rv RequestVar) GetString(key string) string
- func (rv RequestVar) GetTime(key string, format string, loc ...*time.Location) (time.Time, error)
- func (rv RequestVar) GetTimes(key string, format string, loc ...*time.Location) ([]time.Time, error)
- func (rv RequestVar) GetUint(key string) (uint64, error)
- func (rv RequestVar) GetUints(key string) ([]uint64, error)
- type RespSetting
- func (rs RespSetting) GetContentType() string
- func (rs RespSetting) GetHeader() http.Header
- func (rs RespSetting) IsCacheEnable() bool
- func (rs RespSetting) New(cacheEnable bool, header http.Header) *RespSetting
- func (rs *RespSetting) SetCacheEnable(cache bool)
- func (rs *RespSetting) SetHeader(header http.Header)
- type RespWriter
- type ResponseData
- type ResponseFiller
- type ResponseMessage
- func ErrorMessage(err errorx.Error, data ...map[string]interface{}) ResponseMessage
- func ExceptionMessage(err error, codes ...string) ResponseMessage
- func InvalidParamError(param string, value ...interface{}) ResponseMessage
- func MakeErrorMessage(code string, err error, data ...map[string]interface{}) ResponseMessage
- func NewErrorMessage(code, message string, data ...map[string]interface{}) ResponseMessage
- func NewResponseMessage(msgType messageType, code, message string, data ...map[string]interface{}) ResponseMessage
- type ResponseSetting
- type StatusResponse
- type WsCloseHandler
- type WsConnect
- func (wsc *WsConnect) AddCloseHandler(handler WsCloseHandler)
- func (wsc *WsConnect) AddReceiver(receiver WsReceiver)
- func (wsc *WsConnect) GetStatus() uint
- func (wsc *WsConnect) IsOpen() bool
- func (wsc *WsConnect) ListenAndServe()
- func (wsc *WsConnect) SendMessage(message interface{})
- func (wsc *WsConnect) SetupConnection(ws *gws.Conn)
- type WsDecoder
- type WsEncoder
- type WsProgressHandler
- type WsReceiver
- type WsWriter
Constants ¶
View Source
const ( //STANDBY = iota OPENED = iota + 1 CLOSED )
View Source
const InvalidParamErrorCode = "invalid_param"
Variables ¶
View Source
var JSONResponse = &RespSetting{ contentType: "application/json;charset=UTF-8", cacheEnable: false, }
View Source
var RespMessageType = responseMsgType{
Error: messageType("error"),
Info: messageType("info"),
Warning: messageType("warning"),
}
Functions ¶
func ContextGet ¶
func Response ¶
func Response(w http.ResponseWriter, setting ResponseSetting, filler ResponseFiller, statusCode ...int)
export
func ResponseJSON ¶
func ResponseJSON(w http.ResponseWriter, statusCode int, data interface{}, settings ...RespSetting)
export
func SetupWebsocket ¶
func SetupWebsocket(wsc *WsConnect, w http.ResponseWriter, r *http.Request, headers ...map[string]string) (err error)
export
Types ¶
type JSONFiller ¶
type JSONFiller struct {
// contains filtered or unexported fields
}
func NewJSONFiller ¶
func NewJSONFiller(data interface{}) *JSONFiller
func (*JSONFiller) FillResponse ¶
func (jf *JSONFiller) FillResponse(w *RespWriter) (err error)
type RequestVar ¶
func ParseRequestVars ¶
func ParseRequestVars(r *http.Request, keys ...string) RequestVar
func (RequestVar) Exist ¶
func (rv RequestVar) Exist(key string) bool
func (RequestVar) Get ¶
func (rv RequestVar) Get(key string) []string
func (RequestVar) GetString ¶
func (rv RequestVar) GetString(key string) string
type RespSetting ¶
type RespSetting struct {
// contains filtered or unexported fields
}
func NewRespSetting ¶
func NewRespSetting(contentType string, cacheEnable bool, header http.Header) *RespSetting
export
func (RespSetting) GetContentType ¶
func (rs RespSetting) GetContentType() string
func (RespSetting) GetHeader ¶
func (rs RespSetting) GetHeader() http.Header
func (RespSetting) IsCacheEnable ¶
func (rs RespSetting) IsCacheEnable() bool
func (RespSetting) New ¶
func (rs RespSetting) New(cacheEnable bool, header http.Header) *RespSetting
func (*RespSetting) SetCacheEnable ¶
func (rs *RespSetting) SetCacheEnable(cache bool)
func (*RespSetting) SetHeader ¶
func (rs *RespSetting) SetHeader(header http.Header)
type RespWriter ¶
type RespWriter struct {
// contains filtered or unexported fields
}
type ResponseData ¶
type ResponseData map[string]interface{}
type ResponseFiller ¶
type ResponseFiller interface {
FillResponse(w *RespWriter) error
}
type ResponseMessage ¶
type ResponseMessage struct { Code string `json:"error_code"` Message string `json:"error_message"` Data map[string]interface{} `json:"data"` Type messageType `json:"type"` }
func ErrorMessage ¶
func ErrorMessage(err errorx.Error, data ...map[string]interface{}) ResponseMessage
export
func InvalidParamError ¶
func InvalidParamError(param string, value ...interface{}) ResponseMessage
export
func MakeErrorMessage ¶
func MakeErrorMessage(code string, err error, data ...map[string]interface{}) ResponseMessage
export
func NewErrorMessage ¶
func NewErrorMessage(code, message string, data ...map[string]interface{}) ResponseMessage
export
func NewResponseMessage ¶
func NewResponseMessage(msgType messageType, code, message string, data ...map[string]interface{}) ResponseMessage
export
type ResponseSetting ¶
type StatusResponse ¶
type StatusResponse struct { http.ResponseWriter // contains filtered or unexported fields }
func MakeStatusResponse ¶
func MakeStatusResponse(writer http.ResponseWriter) *StatusResponse
func (*StatusResponse) GetStatusCode ¶
func (sr *StatusResponse) GetStatusCode() int
func (*StatusResponse) Hijack ¶
func (sr *StatusResponse) Hijack() (net.Conn, *bufio.ReadWriter, error)
func (*StatusResponse) WriteHeader ¶
func (sr *StatusResponse) WriteHeader(statusCode int)
type WsCloseHandler ¶
type WsConnect ¶
type WsConnect struct { Code string Decoder WsDecoder Encoder WsEncoder Status uint Conn *gws.Conn Duration time.Duration // contains filtered or unexported fields }
func (*WsConnect) AddCloseHandler ¶
func (wsc *WsConnect) AddCloseHandler(handler WsCloseHandler)
func (*WsConnect) AddReceiver ¶
func (wsc *WsConnect) AddReceiver(receiver WsReceiver)
func (*WsConnect) ListenAndServe ¶
func (wsc *WsConnect) ListenAndServe()
func (*WsConnect) SendMessage ¶
func (wsc *WsConnect) SendMessage(message interface{})
func (*WsConnect) SetupConnection ¶
type WsProgressHandler ¶
type WsProgressHandler WsConnect
func (*WsProgressHandler) SendData ¶
func (wph *WsProgressHandler) SendData(msg interface{}) error
type WsReceiver ¶
type WsReceiver func(interface{})
Click to show internal directories.
Click to hide internal directories.