noob

Nov 9, 2022

Changes in this version

type Response

+ func NewResponseNoBody(code HTTPStatusCode, header ...ResponseHeader) Response

Oct 26, 2022

Changes in this version

type ResponseError

+ SetError func(err error) ResponseError

Mar 13, 2022

Changes in this version

type ResponseError

+ SetMessage func(msg string) ResponseError

Mar 13, 2022

Changes in this version

+ const CORSAllowCredentials

+ const CORSAllowHeaders

+ const CORSAllowMethods

+ const CORSAllowOrigin

+ const CORSExposeHeaders

+ const CORSMaxAge

+ const DefaultErrCode

+ var DefaultCORSCfg = CORSCfg

+ var DefaultCfg = Cfg

+ var DefaultForbiddenErrorResponse = NewResponseError(StatusForbidden, ResponseBody{ ... })

+ var DefaultInternalServerErrorResponse = NewResponseError(StatusInternalServerError, ResponseBody{ ... })

+ var DefaultMeta = keyvalue.KeyValue

+ var DefaultNotFoundErrorResponse = NewResponseError(StatusNotFound, ResponseBody{ ... })

+ var DefaultRequestTimeoutErrorResponse = NewResponseError(StatusRequestTimeout, ResponseBody{ ... })

+ var DefaultResponseHeader = map[string]string

+ var DefaultSuccessNoContentResponse = NewResponse(StatusNoContent, ResponseBody{ ... })

+ var DefaultSuccessResponse = NewResponse(StatusOK, ResponseBody{ ... })

+ var DefaultThrottlingCfg = ThrottlingCfg

+ var DefaultTooManyRequestsErrorResponse = NewResponseError(StatusTooManyRequests, ResponseBody{ ... })

+ var Log = _logger.New("core")

+ var StartTime = utils.NewDatetimeNow().GetTime()

+ func GetRuntimeFrames(skip int) *runtime.Frames

+ func StackTrace() []*gostackparse.Goroutine

+ func TCFunc(run Func)

+ type CORSCfg struct

+ AllowCredentials bool

+ AllowHeaders string

+ AllowMethods string

+ AllowOrigins []string

+ Enable bool

+ ExposeHeaders string

+ MaxAge time.Duration

+ type Cfg struct

+ Host string

+ Path string

+ Port int

+ RequestTimeout time.Duration

+ UseListener bool

+ type CoreError struct

+ Code uint

+ Err error

+ Frames *runtime.Frames

+ Meta interface{}

+ Stack []*gostackparse.Goroutine

+ func NewCoreError(msg string, meta ...interface{}) *CoreError

+ func (msg *CoreError) Error() string

+ func (msg *CoreError) Errors() interface{}

+ func (msg *CoreError) JSON() interface{}

+ func (msg *CoreError) Trace()

+ func (msg CoreError) Compose(message string, data ...interface{}) *CoreError

+ func (msg CoreError) MarshalJSON() ([]byte, error)

+ func (msg CoreError) StackTrace() *runtime.Frames

+ type Ctx struct

+ Listener net.Listener

+ Provider *HTTPProviderCtx

+ func (co *Ctx) Start() error

+ type Func struct

+ Catch func(e interface{}, frames *runtime.Frames)

+ Finally func()

+ Try func()

+ type HTTPStatusCode uint

+ const StatusAccepted

+ const StatusAlreadyReported

+ const StatusConflict

+ const StatusContinue

+ const StatusCreated

+ const StatusEarlyHints

+ const StatusExpectationFailed

+ const StatusFailedDependency

+ const StatusFound

+ const StatusGatewayTimeout

+ const StatusGone

+ const StatusHTTPVersionNotSupported

+ const StatusIMUsed

+ const StatusInsufficientStorage

+ const StatusInternalServerError

+ const StatusLengthRequired

+ const StatusLocked

+ const StatusLoopDetected

+ const StatusMethodNotAllowed

+ const StatusMisdirectedRequest

+ const StatusMovedPermanently

+ const StatusMultiStatus

+ const StatusMultipleChoices

+ const StatusNetworkAuthenticationRequired

+ const StatusNoContent

+ const StatusNonAuthoritativeInfo

+ const StatusNotAcceptable

+ const StatusNotExtended

+ const StatusNotImplemented

+ const StatusNotModified

+ const StatusOK

+ const StatusPartialContent

+ const StatusPaymentRequired

+ const StatusPermanentRedirect

+ const StatusPreconditionFailed

+ const StatusPreconditionRequired

+ const StatusProcessing

+ const StatusProxyAuthRequired

+ const StatusRequestEntityTooLarge

+ const StatusRequestHeaderFieldsTooLarge

+ const StatusRequestTimeout

+ const StatusRequestURITooLong

+ const StatusRequestedRangeNotSatisfiable

+ const StatusResetContent

+ const StatusSeeOther

+ const StatusServiceUnavailable

+ const StatusSwitchingProtocols

+ const StatusTeapot

+ const StatusTemporaryRedirect

+ const StatusTooEarly

+ const StatusTooManyRequests

+ const StatusUnavailableForLegalReasons

+ const StatusUnprocessableEntity

+ const StatusUnsupportedMediaType

+ const StatusUpgradeRequired

+ const StatusUseProxy

+ const StatusVariantAlsoNegotiates

+ func (c HTTPStatusCode) Copy() *HTTPStatusCode

type Handler

+ func NewHandler(handler HandlerFunc) Handler

+ func (h Handler) String() string

+ type HandlerChain []Handler

+ func NewHandlerChain(handlers []HandlerFunc) HandlerChain

+ func (hc HandlerChain) String() string

+ func (hc HandlerChain) Strings() []string

type HandlerCtx

+ func (c *HandlerCtx) Copy() *HandlerCtx

+ func (c *HandlerCtx) GetPrevError() (err error)

+ func (c *HandlerCtx) GetPrevResponse() (res Response)

+ func (c *HandlerCtx) Send(res Response)

+ func (c *HandlerCtx) SendError(e interface{}, frames *runtime.Frames)

+ type HandlerFunc func(context *HandlerCtx) (Response, error)

+ func HandleThrottling() HandlerFunc

+ type Query struct

+ Default interface{}

+ Key string

+ Required bool

+ Type QueryValueType

type QueryParser

+ func (p QueryParser) GetQueries(target interface{}, qs []Query) error

+ type QueryValueType uint

+ const QueryValueTypeBool

+ const QueryValueTypeInt

+ const QueryValueTypeInt32

+ const QueryValueTypeInt64

+ const QueryValueTypeString

type Response

+ func HandleAPIStatus(c *HandlerCtx) (Response, error)

+ func HandleNotFound(context *HandlerCtx) (Response, error)

+ func HandleTimeout(c *HandlerCtx) (Response, error)

+ func NewResponse(code HTTPStatusCode, body ResponseBody, header ...ResponseHeader) Response

+ func NewResponseSuccess(body ResponseBody, header ...ResponseHeader) Response

+ ComposeHeader func(h ResponseHeader, replaceExist ...bool) Response

+ type ResponseBody struct

+ Code uint

+ Data interface{}

+ Errors interface{}

+ Message string

+ func (b ResponseBody) Copy() *ResponseBody

+ type ResponseError interface

+ CopyError func() ResponseError

+ Error func() string

+ func NewResponseError(code HTTPStatusCode, body ResponseBody, header ...ResponseHeader) ResponseError

+ type ResponseHeader map[string]string

+ func (r ResponseHeader) Copy() *ResponseHeader

type Router

+ func (e *Router) POSTUSE(handlersFunc ...HandlerFunc)

type ThrottlingCfg

+ Enable bool

Dec 25, 2021

Changes in this version

type ControllerArg

+ Router *Router

+ type DefaultResponse struct

+ Body interface{}

+ Code uint

+ Header map[string]string

+ func (r *DefaultResponse) Compose(sourceRes Response, replaceExist ...bool) Response

+ func (r *DefaultResponse) ComposeBody(body interface{}, replaceExist ...bool) Response

+ func (r *DefaultResponse) Copy() Response

+ func (r *DefaultResponse) GetBody() interface{}

+ func (r *DefaultResponse) GetCode() uint

+ func (r *DefaultResponse) GetHeader() map[string]string

+ func (r *DefaultResponse) SetBody(b interface{}) Response

+ func (r *DefaultResponse) SetCode(c uint) Response

+ func (r *DefaultResponse) SetHeader(h map[string]string) Response

type HTTPController

+ Send func(c *HandlerCtx, res Response)

type HTTPControllerCtx

+ IsDebug bool

+ func (h *HTTPControllerCtx) Send(c *HandlerCtx, res Response)

type HandlerCtx

+ func (c *HandlerCtx) GetNext() HTTPHandler

+ func (c *HandlerCtx) Next() (Response, error)

type Response

+ Copy func() Response

+ GetBody func() interface{}

+ GetCode func() uint

+ GetHeader func() map[string]string

+ SetBody func(b interface{}) Response

+ SetCode func(c uint) Response

+ SetHeader func(h map[string]string) Response

+ type ResponseMap map[uint]Response

type ResponseMapperCfg

+ DefaultHeader *keyvalue.KeyValue

+ StandardResponses ResponseMap

type ResponseMapperCtx

+ DefaultHeader *keyvalue.KeyValue

+ func (m *ResponseMapperCtx) AssignDefaultHeader(r Response)

Dec 13, 2021

Changes in this version

+ type HTTPController interface

+ AdaptHandler func(handler HTTPHandler) Handler

+ AdaptHandlers func(handlers []HTTPHandler) []Handler

+ BranchRouter func(path string) *Router

+ GetSpec func(spec string) HandlerSpec

+ Handle func(spec string, handlers ...HTTPHandler)

+ SendError func(c *HandlerCtx, e interface{}, frames *runtime.Frames)

+ SendSuccess func(c *HandlerCtx, res *Response)

+ SetRouter func(r *Router) *HTTPControllerCtx

+ func NewHTTPController(arg ControllerArg) HTTPController

type HTTPControllerCtx

+ func (h *HTTPControllerCtx) AdaptHandler(handler HTTPHandler) Handler

+ func (h *HTTPControllerCtx) AdaptHandlers(handlers []HTTPHandler) []Handler

type HTTPProviderCtx

+ func HTTP() *HTTPProviderCtx

+ type Handler = gin.HandlerFunc

type HandlerCtx

+ func WrapHandlerCtx(ec *gin.Context) *HandlerCtx

+ type Router struct

+ func (e *Router) AppendHandlers(handlers []Handler)

+ func (e *Router) Branch(path string, fullPath string) *Router

+ func (e *Router) DELETE(path string, handlers ...Handler)

+ func (e *Router) GET(path string, handlers ...Handler)

+ func (e *Router) HEAD(path string, handlers ...Handler)

+ func (e *Router) Handlers() []Handler

+ func (e *Router) OPTIONS(path string, handlers ...Handler)

+ func (e *Router) PATCH(path string, handlers ...Handler)

+ func (e *Router) POST(path string, handlers ...Handler)

+ func (e *Router) PUT(path string, handlers ...Handler)

+ func (e *Router) USE(handlers ...Handler)

Nov 27, 2021

Changes in this version

type StartArg

+ UseListener bool

Nov 27, 2021

Changes in this version

type CoreCfg

+ Listener net.Listener

type CoreCtx

+ Listener net.Listener

Nov 26, 2021

Changes in this version

+ func APIStatus(startTime time.Time, meta keyvalue.KeyValue) keyvalue.KeyValue

Nov 26, 2021

Changes in this version

+ const DefaultMaxBurstSize

+ const DefaultMaxEventPerSec

+ const StatusBadGateway

+ const StatusBadRequest

+ const StatusForbidden

+ const StatusInternalError

+ const StatusNoMethod

+ const StatusNotFound

+ const StatusTooManyRequest

+ const StatusUnauthorized

+ const Version

+ var HTTPError = httpError

+ type CommonController struct

+ Logger logger.Logger

+ StartTime time.Time

+ func (cc CommonController) APIStatus(m keyvalue.KeyValue) HTTPHandler

+ func (cc CommonController) HandleNotFound() HTTPHandler

+ func (cc CommonController) RequestLogger() HTTPHandler

+ func (cc CommonController) Throttling(maxEventsPerSec int, maxBurstSize int) HTTPHandler

+ type ControllerArg struct

+ Logger logger.Logger

+ ResponseMapper *ResponseMapperCtx

+ type CoreCfg struct

+ Context context.Context

+ Meta *keyvalue.KeyValue

+ ResponseMapper *ResponseMapperCtx

+ type CoreCtx struct

+ Logger logger.Logger

+ Meta keyvalue.KeyValue

+ Provider *HTTPProviderCtx

+ Setup func()

+ func New(config *CoreCfg) *CoreCtx

+ func (co *CoreCtx) Start(cfg StartArg)

+ type DefaultResponseCode struct

+ InternalError string

+ Success string

+ type Errors []*apperr.AppErr

+ func (e Errors) MarshalJSON() ([]byte, error)

+ func (e Errors) String() string

+ type ExtHandler = gin.HandlerFunc

+ type ExtHandlerCtx = gin.Context

+ type ExtRouter struct

+ func (e *ExtRouter) AppendHandlers(handlers []ExtHandler)

+ func (e *ExtRouter) Branch(path string, fullPath string) *ExtRouter

+ func (e *ExtRouter) DELETE(path string, handlers ...ExtHandler)

+ func (e *ExtRouter) GET(path string, handlers ...ExtHandler)

+ func (e *ExtRouter) HEAD(path string, handlers ...ExtHandler)

+ func (e *ExtRouter) Handlers() []ExtHandler

+ func (e *ExtRouter) OPTIONS(path string, handlers ...ExtHandler)

+ func (e *ExtRouter) PATCH(path string, handlers ...ExtHandler)

+ func (e *ExtRouter) POST(path string, handlers ...ExtHandler)

+ func (e *ExtRouter) PUT(path string, handlers ...ExtHandler)

+ func (e *ExtRouter) USE(handlers ...ExtHandler)

+ type HTTPControllerCtx struct

+ Debug bool

+ Logger logger.Logger

+ ResponseMapper *ResponseMapperCtx

+ func NewController(arg ControllerArg) *HTTPControllerCtx

+ func (h *HTTPControllerCtx) BranchRouter(path string) *ExtRouter

+ func (h *HTTPControllerCtx) GetSpec(spec string) HandlerSpec

+ func (h *HTTPControllerCtx) Handle(spec string, handlers ...HTTPHandler)

+ func (h *HTTPControllerCtx) SendError(c *HandlerCtx, e interface{}, frames *runtime.Frames)

+ func (h *HTTPControllerCtx) SendSuccess(c *HandlerCtx, res *Response)

+ func (h *HTTPControllerCtx) SetRouter(r *ExtRouter) *HTTPControllerCtx

+ func (h *HTTPControllerCtx) ToExtHandler(handler HTTPHandler) ExtHandler

+ func (h *HTTPControllerCtx) ToExtHandlers(handlers []HTTPHandler) []ExtHandler

+ type HTTPHandler func(context *HandlerCtx) *Response

+ func CORS(config _cors.Cfg) HTTPHandler

+ type HTTPProviderCtx struct

+ Engine *gin.Engine

+ func ExtHTTP() *HTTPProviderCtx

+ func (t HTTPProviderCtx) Router(path string) *ExtRouter

+ func (t HTTPProviderCtx) Run(url string) error

+ func (t HTTPProviderCtx) RunListener(listener net.Listener) error

+ type HandlerCtx struct

+ func WrapExtHandlerCtx(ec *ExtHandlerCtx) *HandlerCtx

+ func (c *HandlerCtx) Errors() Errors

+ func (c *HandlerCtx) StackError(e *apperr.AppErr)

+ type HandlerSpec struct

+ type QueryParser HandlerCtx

+ func (p QueryParser) GetBool(key string, opt ...QueryParserOption) (*bool, error)

+ func (p QueryParser) GetInt(key string, opt ...QueryParserOption) (*int, error)

+ func (p QueryParser) GetInt32(key string, opt ...QueryParserOption) (*int32, error)

+ func (p QueryParser) GetInt64(key string, opt ...QueryParserOption) (*int64, error)

+ func (p QueryParser) GetString(key string, opt ...QueryParserOption) (*string, error)

+ type QueryParserOption struct

+ Default interface{}

+ Required bool

+ type Response struct

+ Body interface{}

+ Code int

+ Header map[string]string

+ func (r *Response) ComposeBody(body interface{})

+ func (r Response) Compose(res Response) *Response

+ func (r Response) ComposeTo(res *Response)

+ type ResponseMapperCfg struct

+ DefaultCode *DefaultResponseCode

+ Logger logger.Logger

+ type ResponseMapperCtx struct

+ DefaultCode *DefaultResponseCode

+ Logger logger.Logger

+ Responses map[string]Response

+ func ResponseMapper(cfg ResponseMapperCfg) *ResponseMapperCtx

+ func (m *ResponseMapperCtx) Get(code string, options *struct{ Success bool }) Response

+ func (m *ResponseMapperCtx) GetInternalError() Response

+ func (m *ResponseMapperCtx) GetSuccess() Response

+ func (m *ResponseMapperCtx) Load(rs map[string]Response)

+ type StartArg struct

+ CORS *cors.Cfg

+ Host string

+ Listener *net.Listener

+ Path string

+ Port int

+ Throttling *ThrottlingCfg

+ type ThrottlingCfg struct

+ MaxBurstSize int

+ MaxEventPerSec int