doris

README

doris

HTTP server for Connect APIs and websites.

Install

go get github.com/altipla-consulting/doris

Contributing

You can make pull requests or create issues in GitHub. Any code you send should be formatted using make gofmt.

License

MIT License

Documentation

Index

• func Connect(r *routing.Router, fn RegisterFn)
• func ConnectCORS(origins []string) cors.Options
• func ConnectOptions(interceptors ...connect.Interceptor) []connect.HandlerOption
• func Error(w http.ResponseWriter, status int)
• func Errorf(code connect.Code, msg string, args ...any) error
• func Handler(handler HandlerError) http.Handler
• func ServerInterceptors() []connect.Interceptor
• type ConnectHub
  • func NewConnectHub(r *Router, opts ...ConnectHubOption) *ConnectHub
  • func (hub *ConnectHub) Mount(fn MountFn)
• type ConnectHubOption
  • func WithCORS(domains ...string) ConnectHubOption
  • func WithInterceptors(interceptors ...connect.Interceptor) ConnectHubOption
• type HandlerError
• type MountFn
• type Option
  • func WithInternal(opts ...Option) Option
  • func WithListener(listener net.Listener) Option
  • func WithPort(port string) Option
  • func WithRoutingOptions(opts ...routing.ServerOption) Option
• type RegisterFn
• type Router
  • func (r *Router) Handle(handler http.Handler)
  • func (r *Router) PathPrefixHandlerHTTP(path string, handler http.Handler)
• type Server
  • func NewServer(opts ...Option) *Server
  • func (server *Server) Context() context.Context
  • func (server *Server) GoBackground(fn func(ctx context.Context) error)
  • func (server *Server) RegisterPort(port string, opts ...Option) *ServerPort
  • func (server *Server) Serve()
• type ServerPort

Functions

func Connect

func Connect(r *routing.Router, fn RegisterFn)

Deprecated: Use NewConnectHub instead.

func ConnectCORS

func ConnectCORS(origins []string) cors.Options

Deprecated: Use NewConnectHub instead.

func ConnectOptions

func ConnectOptions(interceptors ...connect.Interceptor) []connect.HandlerOption

Deprecated: Use NewConnectHub instead.

func Error

func Error(w http.ResponseWriter, status int)

func Errorf

func Errorf(code connect.Code, msg string, args ...any) error

func Handler

func Handler(handler HandlerError) http.Handler

func ServerInterceptors

func ServerInterceptors() []connect.Interceptor

Types

type ConnectHub

type ConnectHub struct {
	// contains filtered or unexported fields
}

ConnectHub helps mounting Connect APIs to their correct endpoints.

func NewConnectHub

func NewConnectHub(r *Router, opts ...ConnectHubOption) *ConnectHub

NewConnectHub creates a new hub prepared to mount Connect APIs.

func (*ConnectHub) Mount

func (hub *ConnectHub) Mount(fn MountFn)

Mount a new API.

type ConnectHubOption

type ConnectHubOption func(cnf *ConnectHub)

ConnectHubOption configures the Connect hub.

func WithCORS

func WithCORS(domains ...string) ConnectHubOption

WithCORS configures the domains authorized to access the API. The standard studio.buf.build is always authorized by default.

func WithInterceptors

func WithInterceptors(interceptors ...connect.Interceptor) ConnectHubOption

WithInterceptors configures the interceptors to configure in the APIs.

type HandlerError

type HandlerError func(w http.ResponseWriter, r *http.Request) error

type MountFn

type MountFn func(opts ...connect.HandlerOption) (string, http.Handler)

MountFn should be implemented by a global function in the API package to register itself.

type Option

type Option func(s *Server, sp *ServerPort, internal bool)

Option of a server.

func WithInternal

func WithInternal(opts ...Option) Option

WithInternal apply the options to the internal server with metrics and health checks. For example it can be used to change the port of the internal server. It only makes sense if enabled at the server level, not in any individual server port.

func WithListener

func WithListener(listener net.Listener) Option

WithListener configures the listener to use for the web server. It is useful to serve in custom configurations like a Unix socket or Tailscale.

func WithPort

func WithPort(port string) Option

WithPort changes the default port of the application. If the env variable PORT is defined it will override anything configured here.

func WithRoutingOptions

func WithRoutingOptions(opts ...routing.ServerOption) Option

WithRoutingOptions configures web server options.

type RegisterFn

type RegisterFn func() (pattern string, handler http.Handler)

Deprecated: Use NewConnectHub instead.

type Router

type Router struct {
	*routing.Server
}

func (*Router) Handle

func (r *Router) Handle(handler http.Handler)

Handle sends all request to the standard HTTP handler.

func (*Router) PathPrefixHandlerHTTP

func (r *Router) PathPrefixHandlerHTTP(path string, handler http.Handler)

PathPrefixHandlerHTTP registers a new HTTP handler for all the routes under the specified prefix.

type Server

type Server struct {
	*ServerPort
	// contains filtered or unexported fields
}

Server is the root server of the application.

func NewServer

func NewServer(opts ...Option) *Server

NewServer creates a new root server in the default port. It won't start until you call Serve() on it.

func (*Server) Context

func (server *Server) Context() context.Context

Context returns a context that will be canceled when the server is stopped.

func (*Server) GoBackground

func (server *Server) GoBackground(fn func(ctx context.Context) error)

GoBackground runs a background goroutine that will be canceled when the server is stopped. The function should return when the context is canceled. If the function returns an error, the server will be stopped prematurely. The server will not exit until all background goroutines have finished.

func (*Server) RegisterPort

func (server *Server) RegisterPort(port string, opts ...Option) *ServerPort

Register a new child server in a different port.

func (*Server) Serve

func (server *Server) Serve()

Serve starts the server and blocks until it is stopped with a signal.

type ServerPort

type ServerPort struct {
	*Router
	// contains filtered or unexported fields
}

ServerPort is a child server in a different custom port.