api

Documentation

Index

• Constants
• func GetSession(r *http.Request) (*contracts.Session, bool)
• func MetricsHandler(p *MetricsProvider) http.HandlerFunc
• type MetricsProvider
• type RoutePermission
• type Server
  • func NewServer(addr, certFile, keyFile string) *Server
  • func (s *Server) AddPublicPath(path string)
  • func (s *Server) Drain(ctx context.Context) error
  • func (s *Server) Handle(pattern string, handler http.Handler)
  • func (s *Server) HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))
  • func (s *Server) RouteRequire(pattern, action, resource string)
  • func (s *Server) SetAuditLogger(a contracts.AuditLogger)
  • func (s *Server) SetAuthFunc(fn func(r *http.Request) (*contracts.Session, error))
  • func (s *Server) SetAuthorizer(a contracts.Authorizer)
  • func (s *Server) SetCSP(header string)
  • func (s *Server) SetHealthChecker(fn func() map[string]error)
  • func (s *Server) SetNodeID(id string)
  • func (s *Server) SetRateLimiter(rl contracts.RateLimiterProvider)
  • func (s *Server) Shutdown(ctx context.Context) error
  • func (s *Server) Start() error

Constants

const SessionKey contextKey = "session"

SessionKey is the context key for storing the authenticated session.

Functions

func GetSession

func GetSession(r *http.Request) (*contracts.Session, bool)

GetSession retrieves the authenticated session from the request context.

func MetricsHandler

func MetricsHandler(p *MetricsProvider) http.HandlerFunc

MetricsHandler returns an http.HandlerFunc that emits Prometheus-format metrics. No external dependency — generates text/plain manually.

Enable via MUXCORE_METRICS_ENABLE=true. The endpoint is registered at /metrics.

Types

type MetricsProvider

type MetricsProvider struct {
	// DroppedEvents returns total events dropped by the event bus.
	DroppedEvents func() int64
	// ActiveSubscribers returns total active event subscriptions.
	ActiveSubscribers func() int
	// ConnPoolSize returns the number of pooled gRPC connections.
	ConnPoolSize func() int
	// RegistryModuleCount returns total registered modules.
	RegistryModuleCount func() int
	// LeaderTerm returns the current cluster election term.
	LeaderTerm func() uint64
	// IsLeader reports whether this node is the cluster leader.
	IsLeader func() bool
}

MetricsProvider supplies runtime metrics for the /metrics endpoint. Each field is a function that returns the current value — called on every scrape so the response is always fresh.

type RoutePermission

type RoutePermission struct {
	Action   string
	Resource string
}

RoutePermission describes the permission required to access a route.

type Server

type Server struct {
	AuthFunc func(r *http.Request) (*contracts.Session, error)
	// contains filtered or unexported fields
}

func NewServer

func NewServer(addr, certFile, keyFile string) *Server

func (*Server) AddPublicPath

func (s *Server) AddPublicPath(path string)

AddPublicPath adds a path that should skip authentication entirely. Requests to public paths are not required to carry a valid session.

func (*Server) Drain

func (s *Server) Drain(ctx context.Context) error

Drain signals the HTTP server to stop accepting new connections and waits for in-flight requests to complete within the given context deadline. After Drain returns, no new requests will be processed. Call Shutdown afterward for final cleanup.

Typical shutdown sequence:

1. srv.Drain(drainCtx) — stop new connections, drain in-flight
2. grpcSrv.GracefulStop() — drain gRPC
3. modMgr.StopAll(...) — stop modules
4. srv.Shutdown(ctx) — release remaining HTTP resources

func (*Server) Handle

func (s *Server) Handle(pattern string, handler http.Handler)

Handle registers an http.Handler for the given pattern.

func (*Server) HandleFunc

func (s *Server) HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))

HandleFunc registers a handler function for the given pattern.

func (*Server) RouteRequire

func (s *Server) RouteRequire(pattern, action, resource string)

RouteRequire registers a permission requirement for a specific route. The route must match an HTTP path pattern registered with Handle/HandleFunc. The authorizer's Can() method will be called with the given action and resource after authentication for all requests to this route.

func (*Server) SetAuditLogger

func (s *Server) SetAuditLogger(a contracts.AuditLogger)

SetAuditLogger sets the audit logger for recording authenticated requests.

func (*Server) SetAuthFunc

func (s *Server) SetAuthFunc(fn func(r *http.Request) (*contracts.Session, error))

SetAuthFunc sets the authentication function for the middleware chain.

func (*Server) SetAuthorizer

func (s *Server) SetAuthorizer(a contracts.Authorizer)

SetAuthorizer sets the authorizer for permission checks in the middleware chain.

func (*Server) SetCSP

func (s *Server) SetCSP(header string)

SetRateLimiter sets the rate limiter module for the middleware chain. SetCSP configures the Content-Security-Policy header sent on all responses. The default is restrictive: "default-src 'none'; frame-ancestors 'none'". Modules that serve HTML content (e.g. admin UI) must call this to set appropriate script-src, style-src, connect-src, and img-src directives.

func (*Server) SetHealthChecker

func (s *Server) SetHealthChecker(fn func() map[string]error)

SetHealthChecker sets a function that returns per-module health status.

func (*Server) SetNodeID

func (s *Server) SetNodeID(id string)

SetNodeID sets the node identifier for audit entries.

func (*Server) SetRateLimiter

func (s *Server) SetRateLimiter(rl contracts.RateLimiterProvider)

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error

func (*Server) Start

func (s *Server) Start() error