A polite Go HTTP server that shuts down gracefully.
Go
Clone or download
lionelbarrow Merge pull request #37 from alapidas/master
Add synchronization aroung global server variable
Latest commit 82a8879 Apr 18, 2016
Permalink
Failed to load latest commit information.
test_helpers Reject requests via kept alive connections after close Nov 5, 2015
.gitignore Initial commit Jan 18, 2013
LICENSE [LICENSE] Standardize to match other BT repos Jul 11, 2014
README.md
helpers_test.go Make NewServer public Nov 22, 2015
interfaces.go Move waitGroup interface to a new file; rearrange some comments May 3, 2015
server.go provide an interface into the number of currently running routines Mar 10, 2016
server_test.go Add synchronization aroung global server variable Apr 4, 2016
static.go Add synchronization aroung global server variable Apr 4, 2016
transition_test.go Make NewServer public Nov 22, 2015

README.md

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