mrserver

Documentation

Index

• Constants
• func DefaultHttpErrorOverrideFunc(err *mrerr.AppError) (int, *mrerr.AppError)
• func HandlerGetHealth() func(w http.ResponseWriter, r *http.Request)
• func HandlerGetStatusOKAsJson() func(w http.ResponseWriter, r *http.Request)
• func HandlerGetStructAsJson(data any, status int) (func(w http.ResponseWriter, r *http.Request), error)
• func PrepareAppToStart(ctx context.Context) (execute func() error, interrupt func(error))
• type CacheableResponseWriter
  • func NewCacheableResponseWriter(w http.ResponseWriter) *CacheableResponseWriter
  • func (w *CacheableResponseWriter) Body() []byte
  • func (w *CacheableResponseWriter) StatusCode() int
  • func (w *CacheableResponseWriter) Write(buf []byte) (int, error)
  • func (w *CacheableResponseWriter) WriteHeader(statusCode int)
• type ErrorResponseSender
• type FileResponseSender
• type HttpController
• type HttpErrorOverrideFunc
• type HttpHandler
• type HttpHandlerAdapterFunc
  • func NewMiddlewareHttpHandlerAdapter(s ErrorResponseSender) (HttpHandlerAdapterFunc, error)
• type HttpHandlerFunc
  • func MiddlewareCheckAccess(section mrperms.AppSection, access mrperms.AccessControl, permission string, ...) HttpHandlerFunc
  • func MiddlewareIdempotency(provider mridempotency.Provider, sender ResponseSender, next HttpHandlerFunc) HttpHandlerFunc
• type HttpMiddleware
  • func MiddlewareGeneral(tr *mrlang.Translator) HttpMiddleware
• type HttpMiddlewareFunc
  • func (f HttpMiddlewareFunc) Middleware(next http.Handler) http.Handler
• type HttpRouter
• type ListenOptions
• type RequestDecoder
• type RequestParserBool
• type RequestParserDateTime
• type RequestParserFile
• type RequestParserImage
• type RequestParserInt64
• type RequestParserItemStatus
• type RequestParserKeyInt32
• type RequestParserListPager
• type RequestParserListSorter
• type RequestParserParamFunc
• type RequestParserString
• type RequestParserUUID
• type RequestParserValidate
• type ResponseEncoder
• type ResponseSender
• type ServerAdapter
  • func NewServerAdapter(ctx context.Context, opts ServerOptions) *ServerAdapter
  • func (s *ServerAdapter) PrepareToStart(ctx context.Context) (execute func() error, interrupt func(error))
  • func (s *ServerAdapter) Shutdown(ctx context.Context) error
  • func (s *ServerAdapter) Start(ctx context.Context) error
• type ServerOptions
• type StatResponseWriter
  • func NewStatResponseWriter(ctx context.Context, w http.ResponseWriter) *StatResponseWriter
  • func (w *StatResponseWriter) Write(buf []byte) (int, error)
  • func (w *StatResponseWriter) WriteHeader(statusCode int)

Constants

const (
	ListenTypeSock = "sock"
	ListenTypePort = "port"
)

Functions

func DefaultHttpErrorOverrideFunc

func DefaultHttpErrorOverrideFunc(err *mrerr.AppError) (int, *mrerr.AppError)

DefaultHttpErrorOverrideFunc - only for: 401, 403, 404, 418, 5XX

func HandlerGetHealth

func HandlerGetHealth() func(w http.ResponseWriter, r *http.Request)

func HandlerGetStatusOKAsJson

func HandlerGetStatusOKAsJson() func(w http.ResponseWriter, r *http.Request)

func HandlerGetStructAsJson

func HandlerGetStructAsJson(data any, status int) (func(w http.ResponseWriter, r *http.Request), error)

func PrepareAppToStart

func PrepareAppToStart(ctx context.Context) (execute func() error, interrupt func(error))

Types

type CacheableResponseWriter

type CacheableResponseWriter struct {
	http.ResponseWriter
	// contains filtered or unexported fields
}

func NewCacheableResponseWriter

func NewCacheableResponseWriter(w http.ResponseWriter) *CacheableResponseWriter

func (*CacheableResponseWriter) Body

func (w *CacheableResponseWriter) Body() []byte

func (*CacheableResponseWriter) StatusCode

func (w *CacheableResponseWriter) StatusCode() int

func (*CacheableResponseWriter) Write

func (w *CacheableResponseWriter) Write(buf []byte) (int, error)

func (*CacheableResponseWriter) WriteHeader

func (w *CacheableResponseWriter) WriteHeader(statusCode int)

type ErrorResponseSender

type ErrorResponseSender interface {
	SendError(w http.ResponseWriter, r *http.Request, err error)
}

type FileResponseSender

type FileResponseSender interface {
	ResponseSender
	SendFile(ctx context.Context, w http.ResponseWriter, file mrtype.File) error
	SendAttachmentFile(ctx context.Context, w http.ResponseWriter, file mrtype.File) error
}

type HttpController

type HttpController interface {
	Handlers() []HttpHandler
}

type HttpErrorOverrideFunc

type HttpErrorOverrideFunc func(err *mrerr.AppError) (int, *mrerr.AppError)

type HttpHandler

type HttpHandler struct {
	Method     string
	URL        string
	Permission string
	Func       HttpHandlerFunc
}

type HttpHandlerAdapterFunc

type HttpHandlerAdapterFunc func(next HttpHandlerFunc) http.HandlerFunc

func NewMiddlewareHttpHandlerAdapter

func NewMiddlewareHttpHandlerAdapter(s ErrorResponseSender) (HttpHandlerAdapterFunc, error)

type HttpHandlerFunc

type HttpHandlerFunc func(w http.ResponseWriter, r *http.Request) error

func MiddlewareCheckAccess

func MiddlewareCheckAccess(
	section mrperms.AppSection,
	access mrperms.AccessControl,
	permission string,
	next HttpHandlerFunc,
) HttpHandlerFunc

func MiddlewareIdempotency

func MiddlewareIdempotency(provider mridempotency.Provider, sender ResponseSender, next HttpHandlerFunc) HttpHandlerFunc

type HttpMiddleware

type HttpMiddleware interface {
	Middleware(next http.Handler) http.Handler
}

func MiddlewareGeneral

func MiddlewareGeneral(tr *mrlang.Translator) HttpMiddleware

type HttpMiddlewareFunc

type HttpMiddlewareFunc func(next http.Handler) http.Handler

func (HttpMiddlewareFunc) Middleware

func (f HttpMiddlewareFunc) Middleware(next http.Handler) http.Handler

type HttpRouter

type HttpRouter interface {
	RegisterMiddleware(handlers ...HttpMiddleware)
	Register(controllers ...HttpController)
	HandlerFunc(method, path string, handler http.HandlerFunc)
	HttpHandlerFunc(method, path string, handler HttpHandlerFunc)
	ServeHTTP(w http.ResponseWriter, r *http.Request)
}

type ListenOptions

type ListenOptions struct {
	AppPath  string
	Type     string
	SockName string
	BindIP   string
	Port     string
}

type RequestDecoder

type RequestDecoder interface {
	ParseToStruct(ctx context.Context, content io.Reader, structPointer any) error
}

type RequestParserBool

type RequestParserBool interface {
	FilterNullableBool(r *http.Request, key string) *bool
}

type RequestParserDateTime

type RequestParserDateTime interface {
	FilterDateTime(r *http.Request, key string) time.Time
}

type RequestParserFile

type RequestParserFile interface {
	FormFile(r *http.Request, key string) (mrtype.File, error)
	FormFileContent(r *http.Request, key string) (mrtype.FileContent, error)
	FormFiles(r *http.Request, key string) ([]mrtype.FileHeader, error)
}

type RequestParserImage

type RequestParserImage interface {
	FormImage(r *http.Request, key string) (mrtype.Image, error)
	FormImageContent(r *http.Request, key string) (mrtype.ImageContent, error)
	FormImages(r *http.Request, key string) ([]mrtype.ImageHeader, error)
}

type RequestParserInt64

type RequestParserInt64 interface {
	PathParamInt64(r *http.Request, name string) int64
	FilterInt64(r *http.Request, key string) int64
	FilterRangeInt64(r *http.Request, key string) mrtype.RangeInt64
	FilterInt64List(r *http.Request, key string) []int64
}

type RequestParserItemStatus

type RequestParserItemStatus interface {
	FilterStatusList(r *http.Request, key string) []mrenum.ItemStatus
}

type RequestParserKeyInt32

type RequestParserKeyInt32 interface {
	PathKeyInt32(r *http.Request, name string) mrtype.KeyInt32
	FilterKeyInt32(r *http.Request, key string) mrtype.KeyInt32
	FilterKeyInt32List(r *http.Request, key string) []mrtype.KeyInt32
}

type RequestParserListPager

type RequestParserListPager interface {
	PageParams(r *http.Request) mrtype.PageParams
}

type RequestParserListSorter

type RequestParserListSorter interface {
	SortParams(r *http.Request, sorter mrview.ListSorter) mrtype.SortParams
}

type RequestParserParamFunc

type RequestParserParamFunc func(r *http.Request, key string) string

type RequestParserString

type RequestParserString interface {
	PathParamString(r *http.Request, name string) string
	// RawParamString - returns nil if the param not found
	RawParamString(r *http.Request, key string) *string
	FilterString(r *http.Request, key string) string
}

type RequestParserUUID

type RequestParserUUID interface {
	PathParamUUID(r *http.Request, name string) uuid.UUID
	FilterUUID(r *http.Request, key string) uuid.UUID
}

type RequestParserValidate

type RequestParserValidate interface {
	Validate(r *http.Request, structPointer any) error
	ValidateContent(ctx context.Context, content []byte, structPointer any) error
}

type ResponseEncoder

type ResponseEncoder interface {
	ContentType() string
	ContentTypeProblem() string
	Marshal(structure any) ([]byte, error)
}

type ResponseSender

type ResponseSender interface {
	Send(w http.ResponseWriter, status int, structure any) error
	SendBytes(w http.ResponseWriter, status int, body []byte) error
	SendNoContent(w http.ResponseWriter) error
}

type ServerAdapter

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

func NewServerAdapter

func NewServerAdapter(ctx context.Context, opts ServerOptions) *ServerAdapter

func (*ServerAdapter) PrepareToStart

func (s *ServerAdapter) PrepareToStart(ctx context.Context) (execute func() error, interrupt func(error))

func (*ServerAdapter) Shutdown

func (s *ServerAdapter) Shutdown(ctx context.Context) error

func (*ServerAdapter) Start

func (s *ServerAdapter) Start(ctx context.Context) error

Start - exec server Serve()

type ServerOptions

type ServerOptions struct {
	Caption         string
	Handler         http.Handler
	ReadTimeout     time.Duration
	WriteTimeout    time.Duration
	ShutdownTimeout time.Duration
	Listen          ListenOptions
}

type StatResponseWriter

type StatResponseWriter struct {
	http.ResponseWriter
	// contains filtered or unexported fields
}

func NewStatResponseWriter

func NewStatResponseWriter(ctx context.Context, w http.ResponseWriter) *StatResponseWriter

func (*StatResponseWriter) Write

func (w *StatResponseWriter) Write(buf []byte) (int, error)

func (*StatResponseWriter) WriteHeader

func (w *StatResponseWriter) WriteHeader(statusCode int)