server

Documentation

Index

• func BodyAllowedForStatus(status int) bool
• func BoxToHttpFileSystem(box goxr.Box) http.FileSystem
• func InitiatorBaseConfigureCli(instance *Initiator) error
• func InitiatorConfigureCliAction(instance *Initiator) error
• func InitiatorPhaseFixLogLevelFlag(instance *Initiator) error
• func InitiatorPrepare(instance *Initiator) error
• func ReportNotHandableProblem(err error, ctx *fasthttp.RequestCtx, logger log.Logger)
• type HttpTime
  • func (instance HttpTime) MarshalText() (text []byte, err error)
  • func (instance *HttpTime) UnmarshalText(text []byte) error
• type Initiator
  • func NewInitiatorFor(app *cli.App) *Initiator
  • func (instance *Initiator) Execute()
• type InitiatorError
  • func InitiatorErrorFor(err error) InitiatorError
  • func (instance InitiatorError) Error() string
• type InitiatorPhase
• type Interceptor
• type JsonResponse
  • func ErrorToHttpResponse(err error) JsonResponse
  • func (instance JsonResponse) Complete(ctx *fasthttp.RequestCtx) JsonResponse
  • func (instance JsonResponse) Serve(ctx *fasthttp.RequestCtx, logger log.Logger)
• type Server
  • func (instance *Server) DoesETagMatched(box goxr.Box, fi os.FileInfo, ctx *fasthttp.RequestCtx) bool
  • func (instance *Server) DoesModifiedMatched(box goxr.Box, fi os.FileInfo, ctx *fasthttp.RequestCtx) bool
  • func (instance *Server) Handle(ctx *fasthttp.RequestCtx)
  • func (instance *Server) HandleError(box goxr.Box, err error, interceptAllowed bool, ctx *fasthttp.RequestCtx)
  • func (instance *Server) Log() log.Logger
  • func (instance *Server) NotModifiedFor(box goxr.Box, fi os.FileInfo, ctx *fasthttp.RequestCtx)
  • func (instance *Server) ResolveInitialTargetPath(box goxr.Box, ctx *fasthttp.RequestCtx) string
  • func (instance *Server) Run() error
  • func (instance *Server) ServeFile(box goxr.Box, path string, ctx *fasthttp.RequestCtx, interceptAllowed bool, ...)
  • func (instance *Server) ShouldHandleStatusCode(box goxr.Box, code int, ctx *fasthttp.RequestCtx) bool
  • func (instance *Server) StatusCodeFor(err error) int
  • func (instance *Server) Validate() error
  • func (instance *Server) WriteFileHeadersFor(fi os.FileInfo, ctx *fasthttp.RequestCtx)
  • func (instance *Server) WriteGenericHeaders(ctx *fasthttp.RequestCtx)

Functions

func BodyAllowedForStatus

func BodyAllowedForStatus(status int) bool

func BoxToHttpFileSystem

func BoxToHttpFileSystem(box goxr.Box) http.FileSystem

func InitiatorBaseConfigureCli

func InitiatorBaseConfigureCli(instance *Initiator) error

func InitiatorConfigureCliAction

func InitiatorConfigureCliAction(instance *Initiator) error

func InitiatorPhaseFixLogLevelFlag

func InitiatorPhaseFixLogLevelFlag(instance *Initiator) error

func InitiatorPrepare

func InitiatorPrepare(instance *Initiator) error

func ReportNotHandableProblem

func ReportNotHandableProblem(err error, ctx *fasthttp.RequestCtx, logger log.Logger)

Types

type HttpTime

type HttpTime time.Time

func (HttpTime) MarshalText

func (instance HttpTime) MarshalText() (text []byte, err error)

func (*HttpTime) UnmarshalText

func (instance *HttpTime) UnmarshalText(text []byte) error

type Initiator

type Initiator struct {
	Server *Server
	App    *cli.App

	Phases []InitiatorPhase
	Fail   func(initiator *Initiator, err error)
}

func NewInitiatorFor

func NewInitiatorFor(app *cli.App) *Initiator

func (*Initiator) Execute

func (instance *Initiator) Execute()

type InitiatorError

type InitiatorError struct {
	Cause    error
	ExitCode int
}

func InitiatorErrorFor

func InitiatorErrorFor(err error) InitiatorError

func (InitiatorError) Error

func (instance InitiatorError) Error() string

type InitiatorPhase

type InitiatorPhase func(initiator *Initiator) error

type Interceptor

type Interceptor interface {
	OnBeforeHandle(box goxr.Box, ctx *fasthttp.RequestCtx) (handled bool, newBox goxr.Box, newCtx *fasthttp.RequestCtx)
	OnAfterHandle(box goxr.Box, ctx *fasthttp.RequestCtx)
	OnTargetPathResolved(box goxr.Box, path string, ctx *fasthttp.RequestCtx) (newPath string)
	OnHandleError(box goxr.Box, err error, interceptAllowed bool, ctx *fasthttp.RequestCtx) (handled bool, newErr error, newCtx *fasthttp.RequestCtx)
}

type JsonResponse

type JsonResponse struct {
	Path    string   `json:"path,omitempty"`
	Code    int      `json:"code,omitempty"`
	Message string   `json:"message,omitempty"`
	Details string   `json:"details,omitempty"`
	Time    HttpTime `json:"time,omitempty"`
}

func ErrorToHttpResponse

func ErrorToHttpResponse(err error) JsonResponse

func (JsonResponse) Complete

func (instance JsonResponse) Complete(ctx *fasthttp.RequestCtx) JsonResponse

func (JsonResponse) Serve

func (instance JsonResponse) Serve(ctx *fasthttp.RequestCtx, logger log.Logger)

type Server

type Server struct {
	Box           goxr.Box
	Configuration configuration.Configuration

	Logger      log.Logger
	Interceptor Interceptor
}

func (*Server) DoesETagMatched

func (instance *Server) DoesETagMatched(box goxr.Box, fi os.FileInfo, ctx *fasthttp.RequestCtx) bool

func (*Server) DoesModifiedMatched

func (instance *Server) DoesModifiedMatched(box goxr.Box, fi os.FileInfo, ctx *fasthttp.RequestCtx) bool

func (*Server) Handle

func (instance *Server) Handle(ctx *fasthttp.RequestCtx)

func (*Server) HandleError

func (instance *Server) HandleError(box goxr.Box, err error, interceptAllowed bool, ctx *fasthttp.RequestCtx)

func (*Server) Log

func (instance *Server) Log() log.Logger

func (*Server) NotModifiedFor

func (instance *Server) NotModifiedFor(box goxr.Box, fi os.FileInfo, ctx *fasthttp.RequestCtx)

func (*Server) ResolveInitialTargetPath

func (instance *Server) ResolveInitialTargetPath(box goxr.Box, ctx *fasthttp.RequestCtx) string

func (*Server) Run

func (instance *Server) Run() error

func (*Server) ServeFile

func (instance *Server) ServeFile(box goxr.Box, path string, ctx *fasthttp.RequestCtx, interceptAllowed bool, statusCode int)

func (*Server) ShouldHandleStatusCode

func (instance *Server) ShouldHandleStatusCode(box goxr.Box, code int, ctx *fasthttp.RequestCtx) bool

func (*Server) StatusCodeFor

func (instance *Server) StatusCodeFor(err error) int

func (*Server) Validate

func (instance *Server) Validate() error

func (*Server) WriteFileHeadersFor

func (instance *Server) WriteFileHeadersFor(fi os.FileInfo, ctx *fasthttp.RequestCtx)

func (*Server) WriteGenericHeaders

func (instance *Server) WriteGenericHeaders(ctx *fasthttp.RequestCtx)