Categorygithub.com/gabstv/manners
modulepackage
0.0.0-20180125124109-595c9a4a88f0
Repository: https://github.com/gabstv/manners.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
11
Dependents
3
Files
433 SLOC

# README

Manners

A polite webserver for Go.

Manners allows you to shut your Go webserver down gracefully, without dropping any requests. It can act as a drop-in replacement for the standard library's http.ListenAndServe function:

func main() {
  handler := MyHTTPHandler()
  manners.ListenAndServe(":7000", handler)
}

Then, when you want to shut the server down:

manners.Close()

(Note that this does not block until all the requests are finished. Rather, the call to manners.ListenAndServe will stop blocking when all the requests are finished.)

Manners ensures that all requests are served by incrementing a WaitGroup when a request comes in and decrementing it when the request finishes.

If your request handler spawns Goroutines that are not guaranteed to finish with the request, you can ensure they are also completed with the StartRoutine and FinishRoutine functions on the server.

Known Issues

Manners does not correctly shut down long-lived keepalive connections when issued a shutdown command. Clients on an idle keepalive connection may see a connection reset error rather than a close. See https://github.com/braintree/manners/issues/13 for details.

Compatability

Manners 0.3.0 and above uses standard library functionality introduced in Go 1.3.

Installation

go get github.com/braintree/manners

# Packages

No description provided by the author

# Functions

Shuts down the default server used by ListenAndServe, ListenAndServeTLS and Serve.
ListenAndServe provides a graceful version of the function provided by the net/http package.
ListenAndServeTLS provides a graceful version of the function provided by the net/http package.
NewListener wraps an existing listener for use with GracefulServer.
NewServer creates a new GracefulServer.
NewListener creates a Listener which accepts connections from an inner Listener and wraps each connection with Server.
NewWithOptions creates a GracefulServer instance with the specified options.
NewWithServer wraps an existing http.Server object and returns a GracefulServer that supports all of the original Server operations.
Serve provides a graceful version of the function provided by the net/http package.

# Structs

A GracefulListener differs from a standard net.Listener in one way: if Accept() is called after it is gracefully closed, it returns a listenerAlreadyClosed error.
A GracefulServer maintains a WaitGroup that counts how many in-flight requests the server is handling.
Options used by NewWithOptions to provide parameters for a GracefulServer instance to be created.
TCPKeepAliveListener sets TCP keep-alive timeouts on accepted connections.
A listener implements a network listener (net.Listener) for TLS connections.

# Type aliases

StateHandler can be called by the server if the state of the connection changes.