server

package

v0.0.0-...-a3e1a49 Latest Latest Go to latest Published: Mar 5, 2025 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/coingecko/anycable-go

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func FetchUID(r *http.Request) (string, error)
func HealthHandler(w http.ResponseWriter, _ *http.Request)
func WriteCORSHeaders(w http.ResponseWriter, r *http.Request, origins []string)
type Config
- func NewConfig() Config
- func (c Config) ToToml() string
type DefaultHeadersExtractor
- func (h *DefaultHeadersExtractor) FromRequest(r *http.Request) map[string]string
type HTTPServer
- func ForPort(port string) (*HTTPServer, error)
- func NewServer(host string, port string, ssl *SSLConfig, maxConn int) (*HTTPServer, error)
type HeadersExtractor
type RequestInfo
- func NewRequestInfo(r *http.Request, extractor HeadersExtractor) (*RequestInfo, error)
- func (i *RequestInfo) AnyCableHeader(key string) string
- func (i *RequestInfo) Param(key string) string
type SSLConfig
- func NewSSLConfig() SSLConfig
- func (opts *SSLConfig) Available() bool

Constants ¶

This section is empty.

Variables ¶

View Source

var (

	// Host is a default bind address for HTTP servers
	Host string = "localhost"
	// SSL is a default configuration for HTTP servers
	SSL *SSLConfig
	// MaxConn is a default configuration for maximum connections
	MaxConn int
	// Default logger
	Logger *slog.Logger = slog.Default()
)

Functions ¶

func FetchUID ¶

func FetchUID(r *http.Request) (string, error)

FetchUID safely extracts uid from `X-Request-ID` header or generates a new one

func HealthHandler ¶

func HealthHandler(w http.ResponseWriter, _ *http.Request)

HealthHandler always reponds with 200 status

func WriteCORSHeaders ¶

func WriteCORSHeaders(w http.ResponseWriter, r *http.Request, origins []string)

Types ¶

type Config ¶

type Config struct {
	Host           string    `toml:"host"`
	Port           int       `toml:"port"`
	AllowedOrigins string    `toml:"allowed_origins"`
	MaxConn        int       `toml:"max_conn"`
	HealthPath     string    `toml:"health_path"`
	SSL            SSLConfig `toml:"ssl"`
}

func NewConfig ¶

func NewConfig() Config

func (Config) ToToml ¶

func (c Config) ToToml() string

type DefaultHeadersExtractor ¶

type DefaultHeadersExtractor struct {
	Headers []string
	Cookies []string
}

func (*DefaultHeadersExtractor) FromRequest ¶

func (h *DefaultHeadersExtractor) FromRequest(r *http.Request) map[string]string

type HTTPServer ¶

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

HTTPServer is wrapper over http.Server

func ForPort ¶

func ForPort(port string) (*HTTPServer, error)

ForPort creates new or returns the existing server for the specified port

func NewServer ¶

func NewServer(host string, port string, ssl *SSLConfig, maxConn int) (*HTTPServer, error)

NewServer builds HTTPServer from config params

func (*HTTPServer) Address ¶

func (s *HTTPServer) Address() string

Address returns server scheme://host:port

func (*HTTPServer) Running ¶

func (s *HTTPServer) Running() bool

Running returns true if server has been started

func (*HTTPServer) SetupHandler ¶

func (s *HTTPServer) SetupHandler(path string, handler http.Handler)

SetupHandler adds new handler to mux

func (*HTTPServer) Shutdown ¶

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

Shutdown shuts down server gracefully.

func (*HTTPServer) ShutdownCtx ¶

func (s *HTTPServer) ShutdownCtx() context.Context

ShutdownCtx returns context for graceful shutdown. It must be used by HTTP handlers to termniates long-running requests (SSE, long-polling).

func (*HTTPServer) Start ¶

func (s *HTTPServer) Start() error

Start server

func (*HTTPServer) StartAndAnnounce ¶

func (s *HTTPServer) StartAndAnnounce(name string) error

StartAndAnnounce prints server info and starts server

func (*HTTPServer) Stopped ¶

func (s *HTTPServer) Stopped() bool

Stopped return true iff server has been stopped by user

type HeadersExtractor ¶

type HeadersExtractor interface {
	FromRequest(r *http.Request) map[string]string
}

type RequestInfo ¶

type RequestInfo struct {
	UID     string
	URL     string
	Headers *map[string]string
	// contains filtered or unexported fields
}

func NewRequestInfo ¶

func NewRequestInfo(r *http.Request, extractor HeadersExtractor) (*RequestInfo, error)

func (*RequestInfo) AnyCableHeader ¶

func (i *RequestInfo) AnyCableHeader(key string) string

func (*RequestInfo) Param ¶

func (i *RequestInfo) Param(key string) string

type SSLConfig ¶

type SSLConfig struct {
	CertPath string `toml:"cert_path"`
	KeyPath  string `toml:"key_path"`
}

SSLConfig contains SSL parameters

func NewSSLConfig ¶

func NewSSLConfig() SSLConfig

NewSSLConfig build a new SSLConfig struct

func (*SSLConfig) Available ¶

func (opts *SSLConfig) Available() bool

Available returns true iff certificate and private keys are set

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL