httpext

type Config struct {
	// ServerNamespace is a name for the server to be used as namespace for the prometheus Metrics
	ServerNamespace string
	// Addr is the address to listen to
	Addr string
	// TLSConfig denotes the TLSConfig to be used
	TLSConfig TLSConfig
	// ReadTimeout denotes the timeout for reading the complete request
	ReadTimeout time.Duration
	// ReadHeaderTimeout denotes the timeout for reading the headers
	ReadHeaderTimeout time.Duration
	// WriteTimeout denotes the timeout for writing the complete response
	WriteTimeout time.Duration
	// IdleTimeout denotes the timeout for an idling request
	IdleTimeout time.Duration
	// MaxHeaderBytes denotes the maximum acceptable size of the request header in bytes
	MaxHeaderBytes int
}

type Handler func(writer ResponseWriter, request *Request)

type Metrics interface {
	// Requests provides the metering.Summary for the http requests
	Requests() metering.Summary
}

type MetricsRegistry interface {
	metering.MetricsRegistry
	// HTTP provides the Metrics for the http subsystem
	HTTP() Metrics
}

type Request struct {
	*http.Request
	// contains filtered or unexported fields
}

type ResponseWriter interface {
	http.ResponseWriter
	// SendResponse sends a response with status code handling internal errors
	SendResponse(statusCode int, body []byte)
	// SendResponseString sends a string response
	SendResponseString(statusCode int, body string)
	// SendJSON marshals the provided object to JSON
	SendJSON(statusCode int, obj interface{})
	// SendJSONBytes sends a marshaled json object
	SendJSONBytes(statusCode int, body []byte)
	// HandleInternalError will handle error occurred sending http.StatusInternalServerError, also logging the error
	HandleInternalError(err error)
	// Status yields the sent status response
	Status() int
}

type Server struct {
	*http.Server
	*http.ServeMux

	Metrics MetricsRegistry
	// contains filtered or unexported fields
}

type TLSConfig struct {
	// MinVersion is the minimum version string (e.g. 1.2)
	MinVersion string
	// CaCertsFile is the path to the CA certificates file to be used
	CaCertsFile string
	// PrivateKeyFile is the key file for the private key
	PrivateKeyFile string
	// PublicKeyFile is the key file for the public key
	PublicKeyFile string
}