server

package

v0.0.0-...-798156f Latest Latest Go to latest Published: Oct 3, 2018 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/DigitalBitsOrg/go

Links

Open Source Insights

Documentation ¶

Index ¶

func AddBasicMiddleware(c *Config)
func BindLoggerMiddleware(requestIDKey interface{}) func(http.Handler) http.Handler
func NewRouter(c *Config) *chi.Mux
func Serve(router *chi.Mux, port int, tls *TLSConfig)
type Config
- func EmptyConfig() *Config
type TLSConfig

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AddBasicMiddleware ¶

func AddBasicMiddleware(c *Config)

AddBasicMiddleware is a helper function that augments the passed in Config with some basic middleware components

func BindLoggerMiddleware ¶

func BindLoggerMiddleware(requestIDKey interface{}) func(http.Handler) http.Handler

BindLoggerMiddleware returns a LoggerMiddleware bound to the passed in requestIdKey, thereby decoupling it from middleware.RequestID

func NewRouter ¶

func NewRouter(c *Config) *chi.Mux

NewRouter creates a new router with the provided config

func Serve ¶

func Serve(router *chi.Mux, port int, tls *TLSConfig)

Serve starts a web server by binding it to a socket and setting up the shutdown signals

Types ¶

type Config ¶

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

Config is the immutable Config file that will be used to construct a server

func EmptyConfig ¶

func EmptyConfig() *Config

EmptyConfig gives you a new empty Config

func (*Config) Middleware ¶

func (c *Config) Middleware(m func(http.Handler) http.Handler)

Middleware adds a middleware to the list

func (*Config) NotFound ¶

func (c *Config) NotFound(handler http.HandlerFunc)

NotFound sets the handler for when a resource is not found

func (*Config) Route ¶

func (c *Config) Route(method string, path string, handler http.HandlerFunc)

Route allows you to set (or override) an existing route by the HTTP method

type TLSConfig ¶

type TLSConfig struct {
	CertificateFile string `toml:"certificate-file" valid:"required"`
	PrivateKeyFile  string `toml:"private-key-file" valid:"required"`
}

TLSConfig specifies the TLS portion of a config

Source Files ¶

View all Source files

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