anyhttp

Create golang http.Server for different listen address types

Go to file

Balakrishnan Balasubramanian 94c737a02b Merge pull request 'Change address syntax to be a URL' (#3 ) from addr-url into main Reviewed-on: #3		2024-12-19 10:06:02 -05: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_test.go	Fix golint issues and add test	2024-12-18 15:38:52 -05:00
anyhttp.go	do dupe keys check only once	2024-12-18 15:45:36 -05: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	update README	2024-12-19 09:46:36 -05: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=<socket_path>&mode=<socket file mode>&remove_existing=<yes|no>

Examples

unix?path=relative/path.sock
unix?path=/var/run/app/absolutepath.sock
unix?path=/run/app.sock&mode=600&remove_existing=no

option	description	default
path	path to unix socket	Required
mode	socket file mode	666
remove_existing	Whether to remove existing socket file or fail	true

Systemd Socket activated fd:

Syntax

sysd?idx=<fd index>&name=<fd name>&check_pid=<yes|no>&unset_env=<yes|no>&idle_timeout=<duration>

Only one of idx or name has to be set

Examples:

# First (or only) socket fd passed to app
sysd?idx=0

# Socket with FileDescriptorName
sysd?name=myapp

# Using default name and auto shutdown if no requests received in last 30 minutes
sysd?name=myapp.socket&idle_timeout=30m

option	description	default
name	Name configured via FileDescriptorName or socket file name	Required
idx	FD Index. Actual fd num will be 3 + idx	Required
idle_timeout	time to wait before shutdown. syntax	no auto shutdown
check_pid	Check process PID matches LISTEN_PID	true
unset_env	Unsets the LISTEN* environment variables, so they don't get passed to any child processes	true

TCP

If the address is not one of above, it is assumed to be tcp and passed to http.ListenAndServe.