vinxi

type Metadata struct {
	// ID stores the unique instance identifier.
	ID string `json:"id"`
	// Name stores the vinxi instance name identifier.
	Name string `json:"name,omitempty"`
	// Description stores the vinxi instance friendly description.
	// This field is optional.
	Description string `json:"description,omitempty"`
	// Hostname stores the current hostname where vinxi is running.
	// This is platform specific and could be empty.
	Hostname string `json:"hostname,omitempty"`
	// Platform stores the current runtime platform.
	Platform string `json:"platform,omitempty"`
	// ServerOptions stores the http.Server init options for further reference.
	ServerOptions ServerOptions `json:"server,omitempty"`
}

type Middleware interface {
	// Use is used to register one or multiple middleware handlers.
	Use(...interface{}) Middleware
	// UsePhase is used to register one or multiple middleware
	// handlers for a specific middleware phase.
	UsePhase(string, ...interface{}) Middleware
	// UseFinalHandler is used to register the final request handler
	// usually to define the error or forward handlers.
	UseFinalHandler(http.Handler) Middleware
	// SetParent allows hierarchical middleware inheritance.
	SetParent(layer.Middleware)
}

type Server struct {
	// Vinxi stores the Vinxi layer instance.
	*Vinxi

	// Server stores the http.Server instance.
	Server *http.Server

	// Options stores the server start options.
	Options ServerOptions
}

type ServerOptions struct {
	Port         int    `json:"port,omitempty"`
	ReadTimeout  int    `json:"readTimeout"`
	WriteTimeout int    `json:"writeTimeout"`
	Addr         string `json:"address"`
	Forward      string `json:"forward,omitempty"`
	CertFile     string `json:"certificate,omitempty"`
	KeyFile      string `json:"-"`
}

type Vinxi struct {
	// Medata stores the vinxi instance specific metadata.
	Metadata *Metadata
	// Layer stores the proxy level middleware layer.
	Layer *layer.Layer
	// Router stores the built-in router.
	Router *router.Router
}