server

Documentation

Index

• Constants
• Variables
• type Option
  • func WithCORS(allowedOrigins []string) Option
  • func WithDefaultHeaders(headers http.Header) Option
  • func WithGzipHandler() Option
  • func WithInputLimitValidator(inputMax int) Option
  • func WithLogger(logger *logrus.Logger) Option
  • func WithPProf(prefix string) Option
• type Service
• type ServiceRegistry
  • func NewServiceRegistry() ServiceRegistry
  • func (rlh ServiceRegistry) GetServiceForList(name string) Service
  • func (rlh ServiceRegistry) HasServiceForList(name string) bool
  • func (rlh *ServiceRegistry) Register(listName string, svc Service) *ServiceRegistry
• type TySugServer
  • func NewHTTP(sr ServiceRegistry, mux *http.ServeMux, options ...Option) TySugServer
  • func (tss *TySugServer) ListenOnAndServe(addr string) error
• type Validator

Constants

const (
	CtxRequestID contextKey = iota
)

Context value parameters

const (
	HeaderRequestID = "X-Request-ID"
)

Header constants

Variables

var (
	ErrMissingBody        = errors.New("missing body")
	ErrInvalidRequest     = errors.New("invalid request")
	ErrInvalidRequestBody = errors.New("invalid request body")
	ErrBodyTooLarge       = errors.New("body too large")
)

Errors

Types

type Option

type Option func(*TySugServer)

Option is a handy type used for configuration purposes

func WithCORS

func WithCORS(allowedOrigins []string) Option

WithCORS adds the CORS handler to the request handling

func WithDefaultHeaders

func WithDefaultHeaders(headers http.Header) Option

WithDefaultHeaders sets the default headers to be used when writing a response.

func WithGzipHandler

func WithGzipHandler() Option

WithGzipHandler adds a gzip handler to the server's handlers

func WithInputLimitValidator

func WithInputLimitValidator(inputMax int) Option

WithInputLimitValidator specifies a max input-value limit validator

func WithLogger

func WithLogger(logger *logrus.Logger) Option

WithLogger sets the logger to be used when encountering http-related errors. Errors are written to the standard error output in most cases. Printing on the standard output is reserved to extreme case where writing on stderr failed.

func WithPProf

func WithPProf(prefix string) Option

WithPProf enables pprof

type Service

type Service interface {
	Find(ctx context.Context, input string) (string, float64, bool)
}

Service is the type any service must implement

type ServiceRegistry

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

ServiceRegistry holds (opinionated) service objects for handling specific requests

func NewServiceRegistry

func NewServiceRegistry() ServiceRegistry

NewServiceRegistry creates a new registry

func (ServiceRegistry) GetServiceForList

func (rlh ServiceRegistry) GetServiceForList(name string) Service

GetServiceForList returns a service able to handle a specific list

func (ServiceRegistry) HasServiceForList

func (rlh ServiceRegistry) HasServiceForList(name string) bool

HasServiceForList returns true only if a service has been registered for a certain list

func (*ServiceRegistry) Register

func (rlh *ServiceRegistry) Register(listName string, svc Service) *ServiceRegistry

Register registers a new service with a list of references

type TySugServer

type TySugServer struct {
	Logger *logrus.Logger
	// contains filtered or unexported fields
}

TySugServer the HTTP server

func NewHTTP

func NewHTTP(sr ServiceRegistry, mux *http.ServeMux, options ...Option) TySugServer

NewHTTP constructs a new TySugServer

func (*TySugServer) ListenOnAndServe

func (tss *TySugServer) ListenOnAndServe(addr string) error

ListenOnAndServe allows to set the host:port URL late. It calls ListenAndServe()

type Validator

type Validator func(TSRequest tySugRequest) error

Validator is a type to validate a client request, returning a nil error means all went well.