Documentation
¶
Overview ¶
Package tinyhttp provides HTTP server implementation.
Index ¶
- type Server
- type ServerConfig
- type ServerOpt
- func IdleTimeout(timeout time.Duration) ServerOpt
- func Network(network string) ServerOpt
- func ReadTimeout(timeout time.Duration) ServerOpt
- func RemoteIPHeader(header string) ServerOpt
- func SecurityHeaders(securityHeaders bool) ServerOpt
- func ShutdownTimeout(timeout time.Duration) ServerOpt
- func TLS(cert, key string) ServerOpt
- func TrustedProxies(trustedProxies []string) ServerOpt
- func WriteTimeout(timeout time.Duration) ServerOpt
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Server ¶
Server is an object representing fiber.App and implementing the tiny.Service interface.
func (*Server) OnPanic ¶
OnPanic sets a handler for requests that resulted in panic and would end up as 500s.
type ServerConfig ¶
type ServerConfig struct {
// Network is a network type for the listener (default: "tcp").
Network string
// SecurityHeaders defines whether to include HTTP security headers to all responses or not (default: true).
SecurityHeaders bool
// ShutdownTimeout defines a maximal timeout of HTTP server shutdown (default: 5s).
ShutdownTimeout time.Duration
// TLSCert is a path to TLS certificate to use. When specified with TLSKey - enables TLS mode.
TLSCert string
// TLSKey is a path to TLS key to use. When specified with TLSCert - enables TLS mode.
TLSKey string
// ReadTimeout is a timeout used when creating underlying http server (see http.Server) (default: 5s).
ReadTimeout time.Duration
// WriteTimeout is a timeout used when creating underlying http server (see http.Server) (default: 10s).
WriteTimeout time.Duration
// IdleTimeout is a timeout used when creating underlying http server (see http.Server) (default 2m).
IdleTimeout time.Duration
// TrustedProxies is a list of CIDR address ranges that can be trusted when handling RemoteIP header.
// (default: "10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16", "127.0.0.0/8", "fc00::/7", "::1/128")
TrustedProxies []string
// RemoteIPHeaders is a list of headers that overwrite the value of client's remote address.
// (default: "X-Forwarded-For")
RemoteIPHeader string
// contains filtered or unexported fields
}
ServerConfig holds a configuration for NewServer.
type ServerOpt ¶
type ServerOpt = func(*ServerConfig)
ServerOpt is an option to be specified to NewServer.
func IdleTimeout ¶
IdleTimeout is a timeout used when creating underlying http server (see http.Server).
func ReadTimeout ¶
ReadTimeout is a timeout used when creating underlying http server (see http.Server).
func RemoteIPHeader ¶ added in v1.0.38
RemoteIPHeader is a name of the header that overwrites the value of client's remote address.
func SecurityHeaders ¶
SecurityHeaders defines whether to include HTTP security headers to all responses or not.
func ShutdownTimeout ¶
ShutdownTimeout defines a maximal timeout of HTTP server shutdown.
func TrustedProxies ¶
TrustedProxies is a list of CIDR address ranges that can be trusted when handling RemoteIP header.
func WriteTimeout ¶
WriteTimeout is a timeout used when creating underlying http server (see http.Server).