server

type Config struct {
	// ErrorEncoder is the server's error encoder. This wraps the error encoder
	// configured by the client. Clients should not implement error logging in
	// here them self. This is done by the server itself. Clients must not
	// implement error response writing them self. This is done by the server
	// itself. Duplicated response writing will lead to runtime panics.
	ErrorEncoder kithttp.ErrorEncoder
	// Logger is the logger used to print log messages.
	Logger micrologger.Logger
	// Router is a HTTP handler for the server. The returned router will have all
	// endpoints registered that are listed in the endpoint collection.
	Router *mux.Router

	// EnableDebugServer boolean flag to enable debug server on
	// http://127.0.0.1:6060/debug. This server is primarily used to expose
	// net/http/pprof.Handler.
	EnableDebugServer bool
	// Endpoints is the server's configured list of endpoints. These are the
	// custom endpoints configured by the client.
	Endpoints []Endpoint
	// HandlerWrapper is a wrapper provided to interact with the request on its
	// roots.
	HandlerWrapper func(h http.Handler) http.Handler
	// ListenAddress is the address the server is listening on.
	ListenAddress string
	// ListenMetricsAddress is an optional address where the server will expose the
	// `/metrics` endpoint for prometheus scraping. When left blank the `/metrics`
	// endpoint will be available at the ListenAddress.
	ListenMetricsAddress string
	// LogAccess decides whether to emit logs for each requested route.
	LogAccess bool
	// RequestFuncs is the server's configured list of request functions. These
	// are the custom request functions configured by the client.
	RequestFuncs []kithttp.RequestFunc
	// ServiceName is the name of the micro-service implementing the microkit
	// server. This is used for logging and instrumentation.
	ServiceName string
	// TLSCAFile is the file path to the certificate root CA file, if any.
	TLSCAFile string
	// TLSKeyFilePath is the file path to the certificate public key file, if any.
	TLSCrtFile string
	// TLSKeyFilePath is the file path to the certificate private key file, if
	// any.
	TLSKeyFile string
	// Viper is a configuration management object.
	Viper *viper.Viper
}

type Endpoint interface {
	// Decoder returns the kithttp.DecodeRequestFunc used to decode a request
	// before the actual endpoint is executed.
	Decoder() kithttp.DecodeRequestFunc
	// Decoder returns the kithttp.EncodeResponseFunc used to encode a response
	// after the actual endpoint was executed.
	Encoder() kithttp.EncodeResponseFunc
	// Endpoint returns the kitendpoint.Endpoint which receives a decoded response
	// and forwards any workload to the internal service object reference.
	Endpoint() kitendpoint.Endpoint
	// Method returns the HTTP verb used to register the endpoint.
	Method() string
	// Middlewares returns the middlewares the endpoint configures to be run
	// before the actual endpoint is being invoked.
	Middlewares() []kitendpoint.Middleware
	// Name returns the name of the endpoint which can be used to label metrics or
	// annotate logs.
	Name() string
	// Path returns the HTTP request URL path used to register the endpoint.
	Path() string
}

type ResponseError interface {
	// Code returns the code being tracked using SetCode. If this code is not set
	// using SetCode it defaults to CodeInternalError.
	Code() string
	// Error returns the message of the underlying error.
	Error() string
	// Message returns the message being tracked using SetMessage. If this message
	// is not set using SetMessage it defaults to the error message of the
	// underlying error.
	Message() string
	// SetCode tracks the given response code for the current response error. The
	// given response code will be used for logging, instrumentation and response
	// creation.
	SetCode(code string)
	// SetMessage tracks the given response message for the current response
	// error. The given response message will be used for response creation.
	SetMessage(message string)
	// Underlying returns the actual underlying error, which is expected to be of
	// type kithttp.Error.
	Underlying() error
}

type ResponseErrorConfig struct {
	// Settings.
	Underlying error
}

type ResponseWriter interface {
	// BodyBuffer returns the buffer which is used to track the bytes being
	// written to the response.
	BodyBuffer() *bytes.Buffer
	// HasWritten expresses whether the underlying response writer has already
	// written anything to the response body.
	HasWritten() bool
	// Header is only a wrapper around http.ResponseWriter.Header.
	Header() http.Header
	// StatusCode returns either the default status code of the one that was
	// actually written using WriteHeader.
	StatusCode() int
	// Write is only a wrapper around http.ResponseWriter.Write.
	Write(b []byte) (int, error)
	// WriteHeader is a wrapper around http.ResponseWriter.Write. In addition to
	// that it is used to track the written status code.
	WriteHeader(c int)
}

type ResponseWriterConfig struct {
	// Settings.
	BodyBuffer     *bytes.Buffer
	ResponseWriter http.ResponseWriter
	StatusCode     int
}

type Server interface {
	// Boot registers the configured endpoints and starts the server under the
	// configured address.
	Boot()
	// Config returns the servers configuration as given by the client.
	Config() Config
	// Shutdown stops the running server gracefully.
	Shutdown()
}