Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/braintree/manners
A polite Go HTTP server that shuts down gracefully.
https://github.com/braintree/manners
Last synced: about 2 months ago
JSON representation
A polite Go HTTP server that shuts down gracefully.
- Host: GitHub
- URL: https://github.com/braintree/manners
- Owner: braintree
- License: mit
- Created: 2013-01-18T23:00:50.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2018-10-28T10:22:32.000Z (almost 6 years ago)
- Last Synced: 2024-07-21T00:33:28.375Z (2 months ago)
- Language: Go
- Size: 85.9 KB
- Stars: 994
- Watchers: 35
- Forks: 103
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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:
```go
func main() {
handler := MyHTTPHandler()
manners.ListenAndServe(":7000", handler)
}
```Then, when you want to shut the server down:
```go
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`