anyhttp

Create golang http.Server for different listen address types

Go to file

Balakrishnan Balasubramanian 0693a56697 add doc for idle server auto shutdown		2023-09-11 21:01:20 -04:00
examples/idle_server_shutdown	Add example for idle	2023-05-09 22:45:52 -04:00
idle	add basic test	2023-09-11 20:44:52 -04:00
anyhttp.go	un http Server async and return error via channel	2023-09-11 20:28:04 -04:00
go.mod	initial version	2023-04-20 16:31:35 -04:00
LICENSE	initial version	2023-04-20 16:31:35 -04:00
README.md	add doc for idle server auto shutdown	2023-09-11 21:01:20 -04:00

README.md

Create http server listening on unix sockets and systemd socket activated fds

Quick Usage

go get go.balki.me/anyhttp

Just replace http.ListenAndServe with anyhttp.ListenAndServe.

- http.ListenAndServe(addr, h)
+ anyhttp.ListenAndServe(addr, h)

Address Syntax

Unix socket

Syntax

unix/<path to socket>

Examples

unix/relative/path.sock
unix//var/run/app/absolutepath.sock

Systemd Socket activated fd:

Syntax

sysd/fdidx/<fd index starting at 0>
sysd/fdname/<fd name set using FileDescriptorName socket setting >

Examples:

# First (or only) socket fd passed to app
sysd/fdidx/0

# Socket with FileDescriptorName
sysd/fdname/myapp

# Using default name
sysd/fdname/myapp.socket

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

: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)

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