api

Documentation

Index

• func ValidateCIDRs(cidrs []string) error
• type ApiListener
  • func NewApiListener(cfg ApiListenerConfig, httpHandler http.Handler) (*ApiListener, error)
  • func (l *ApiListener) Addr() string
  • func (l *ApiListener) Start(ctx context.Context) error
  • func (l *ApiListener) Stop() error
  • func (l *ApiListener) Type() string
• type ApiListenerConfig

Functions

func ValidateCIDRs

func ValidateCIDRs(cidrs []string) error

ValidateCIDRs checks that all entries are valid CIDR notations or bare IPs. Returns an error listing any unparseable entries, so misconfigurations are caught at startup rather than silently ignored.

Types

type ApiListener

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

func NewApiListener

func NewApiListener(cfg ApiListenerConfig, httpHandler http.Handler) (*ApiListener, error)

func (*ApiListener) Addr

func (l *ApiListener) Addr() string

func (*ApiListener) Start

func (l *ApiListener) Start(ctx context.Context) error

Start begins the HTTP server and listens for shutdown signal Returns an error channel that will receive any startup errors

func (*ApiListener) Stop

func (l *ApiListener) Stop() error

func (*ApiListener) Type

func (l *ApiListener) Type() string

type ApiListenerConfig

type ApiListenerConfig struct {
	Logger               *logger.GatedLogger
	Address              string
	TLSCertFile          string
	TLSKeyFile           string
	TLSClientCAFile      string
	TLSEnabled           bool
	TLSRequireClientCert *bool    // nil = default (true when TLSClientCAFile set)
	TrustedProxies       []string // CIDR ranges for LB cert forwarding
}