balki/anyhttp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add doc for idle server auto shutdown

Browse Source
This commit is contained in:
Balakrishnan Balasubramanian 2023-09-11 21:01:20 -04:00
parent e95d2d0a96
commit 0693a56697
1 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,4 +1,4 @@
Create http server listening on unix sockets or systemd socket activated fds
Create http server listening on unix sockets and systemd socket activated fds
## Quick Usage
@ -44,14 +44,29 @@ Examples:
### TCP port
If the address is a number less than 65536, it is assumed as a port and passed as `http.ListenAndServe(":<port>",...)`
Anything else is directly passed to `http.ListenAndServe` as well. Below examples should work
If the address is a number less than 65536, it is assumed as a port and passed
as `http.ListenAndServe(":<port>",...)` Anything else is directly passed to
`http.ListenAndServe` as well. Below examples should work
:http
:8888
127.0.0.1:8080
## Idle server auto shutdown
When using systemd socket activation, idle servers can be shut down to save on
resources. They will be restarted with socket activation when new request
arrives. Quick example for the case. (Error checking skipped for brevity)
```go
addrType, httpServer, done, _ := anyhttp.Serve(addr, idle.WrapHandler(nil))
if addrType == anyhttp.SystemdFD {
idle.Wait(30 * time.Minute)
httpServer.Shutdown(context.TODO())
}
<-done
```
## Documentation
https://pkg.go.dev/go.balki.me/anyhttp
@ -59,4 +74,4 @@ https://pkg.go.dev/go.balki.me/anyhttp
### Related links
* https://gist.github.com/teknoraver/5ffacb8757330715bcbcc90e6d46ac74#file-unixhttpd-go
* https://github.com/coreos/go-systemd/tree/main/activation
* https://github.com/coreos/go-systemd/tree/main/activation