server

Documentation

Index

• Variables
• type FileServer
  • func NewFileServer(loggingService *logging.Service, ...) FileServer
  • func (fileServer FileServer) Serve(ctx context.Context, configuration FileServerConfiguration) error
• type FileServerConfiguration
• type ProxyRoutes
  • func NewProxyRoutes(routeMappings []string) (ProxyRoutes, error)
  • func NewProxyRoutesFromLegacy(pathPrefix string, backendURL string) (ProxyRoutes, error)
  • func (routes ProxyRoutes) IsEmpty() bool
• type ProxyStreamingPolicies
  • func NewProxyStreamingPolicies(mappings []string) (ProxyStreamingPolicies, error)
  • func (policies ProxyStreamingPolicies) IsUnbuffered(requestPath string) bool
• type RouteResponsePolicies
  • func NewRouteResponsePolicies(mappings []string) (RouteResponsePolicies, error)
  • func (policies RouteResponsePolicies) HeadersForPath(requestPath string) map[string]string
  • func (policies RouteResponsePolicies) IsEmpty() bool
• type TLSConfiguration

Variables

var (
	ErrInvalidProxyRoute  = errors.New("proxy.route.invalid")
	ErrInvalidProxyRoutes = errors.New("proxy.routes.invalid")
)

var ErrInvalidProxyStreamingPolicy = errors.New("proxy.streaming.policy.invalid")

var ErrInvalidRouteResponsePolicy = errors.New("route.response.policy.invalid")

Types

type FileServer

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

FileServer serves files over HTTP or HTTPS.

func NewFileServer

func NewFileServer(loggingService *logging.Service, servingAddressFormatter serverdetails.ServingAddressFormatter) FileServer

NewFileServer constructs a FileServer.

func (FileServer) Serve

func (fileServer FileServer) Serve(ctx context.Context, configuration FileServerConfiguration) error

Serve runs the HTTP server until the context is cancelled or an error occurs.

type FileServerConfiguration

type FileServerConfiguration struct {
	BindAddress             string
	Port                    string
	DirectoryPath           string
	ProtocolVersion         string
	DisableDirectoryListing bool
	EnableMarkdown          bool
	BrowseDirectories       bool
	InitialFileRelativePath string
	LoggingType             string
	TLS                     *TLSConfiguration
	ProxyRoutes             ProxyRoutes
	RouteResponsePolicies   RouteResponsePolicies
	ProxyStreamingPolicies  ProxyStreamingPolicies
}

type ProxyRoutes

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

func NewProxyRoutes

func NewProxyRoutes(routeMappings []string) (ProxyRoutes, error)

func NewProxyRoutesFromLegacy

func NewProxyRoutesFromLegacy(pathPrefix string, backendURL string) (ProxyRoutes, error)

func (ProxyRoutes) IsEmpty

func (routes ProxyRoutes) IsEmpty() bool

type ProxyStreamingPolicies

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

func NewProxyStreamingPolicies

func NewProxyStreamingPolicies(mappings []string) (ProxyStreamingPolicies, error)

func (ProxyStreamingPolicies) IsUnbuffered

func (policies ProxyStreamingPolicies) IsUnbuffered(requestPath string) bool

type RouteResponsePolicies

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

func NewRouteResponsePolicies

func NewRouteResponsePolicies(mappings []string) (RouteResponsePolicies, error)

func (RouteResponsePolicies) HeadersForPath

func (policies RouteResponsePolicies) HeadersForPath(requestPath string) map[string]string

func (RouteResponsePolicies) IsEmpty

func (policies RouteResponsePolicies) IsEmpty() bool

type TLSConfiguration

type TLSConfiguration struct {
	CertificatePath   string
	PrivateKeyPath    string
	LoadedCertificate *tls.Certificate
}

TLSConfiguration describes transport layer security configuration.