httprouter

type AuthAccessType ¶

type AuthAccessType int

const (
	AccessTypePublic AuthAccessType = iota
	AccessTypeQuota
	AccessTypePrivate
	AccessTypeAdmin
)

type HTTPContext ¶

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

HTTPContext is the Context for an HTTP request.

func (h *HTTPContext) Send(msg []byte, httpStatusCode int) error

func (h *HTTPContext) URLParam(key string) string

type HTTProuter ¶

type HTTProuter struct {
	Mux        *chi.Mux
	TLSconfig  *tls.Config
	TLSdomain  string
	TLSdirCert string
	// contains filtered or unexported fields
}

HTTProuter is a thread-safe multiplexer http(s) router using go-chi and autocert with a set of preconfigured options. The router abstracts the HTTP layer and uses a custom Message type that allows create handlers in a comfortable manner. Allows multiple different kind of data processors by using the RouterNamespace interface. Each processor is identified by a unique namespace string which must be specified when adding handlers. Handlers can be Public, Private and Administrator. The proper checks must be implemented by the RouterNamespace implementation.

func (r *HTTProuter) AddAdminHandler(namespaceID,
	pattern, HTTPmethod string, handler RouterHandlerFn)

func (r *HTTProuter) AddNamespace(id string, rns RouterNamespace)

func (r *HTTProuter) AddPrivateHandler(namespaceID,
	pattern, HTTPmethod string, handler RouterHandlerFn)

func (r *HTTProuter) AddPublicHandler(namespaceID,
	pattern, HTTPmethod string, handler RouterHandlerFn)

func (r *HTTProuter) AddQuotaHandler(namespaceID,
	pattern, HTTPmethod string, handler RouterHandlerFn)

func (r *HTTProuter) AddRawHTTPHandler(pattern, HTTPmethod string, handler http.HandlerFunc)

func (r *HTTProuter) Address() net.Addr

func (r *HTTProuter) EnablePrometheusMetrics(prometheusID string)

func (r *HTTProuter) ExposePrometheusEndpoint(path string)

func (r *HTTProuter) Init(host string, port int) error

type Message ¶

type Message struct {
	Data      any
	TimeStamp time.Time
	Path      []string
	Context   *HTTPContext
}

Message is a wrapper for messages for a RouterNamespace implementation. Data is set by the namespace and can be of any type (implementation details should be checked). In order to send a reply, Context.Send() should be called.

type RouterHandlerFn ¶

type RouterHandlerFn = func(msg Message)

RouterHandlerFn is the function signature for adding handlers to the HTTProuter.

type RouterNamespace ¶

type RouterNamespace interface {
	AuthorizeRequest(data any, accessType AuthAccessType) (valid bool, err error)
	ProcessData(req *http.Request) (data any, err error)
}

RouterNamespace is the interface that a HTTProuter handler should follow in order to become a valid namespace.