README
¶
DIAMOND ⋄
Runlevels for your web application
Diamond provides a UNIX socket for administrators to gracefully shutdown an application, such as a web server.
Apart from only shutting down, the admin can change gears, triggering functions and killing/starting listeners.
The "KICK" feature allows upgrading a program with minimal downtime, kicking the old running process gracefully.
If diamond-admin doesn't run on your platform (bsd?) you can still use the client library!
⚡ telinit 3
Using diamond-admin
You can open admin interface by using no arguments:
diamond-admin -s diamond.sock
Start all listeners and http servers
diamond-admin -s diamond.sock RUNLEVEL 3
Stop all listeners, cut http connections
diamond-admin -s diamond.sock RUNLEVEL 1
Using the library
Diamond requires a recent version of Go
// New creates a new admin socket and starts listening for commands
s, err := diamond.New("/tmp/diamond.socket")
if err != nil {
log.Fatalln(err)
}
// Add variety of http handlers and their addr to listen on
// They won't start listening right away, so they could be
// occupied by other servers
s.AddHTTPHandler(":8080", http.HandlerFunc(myHandler))
s.AddHTTPHandler(":8081", http.HandlerFunc(handler2))
s.AddHTTPHandler(":8082", handler3)
// start in multiuser mode, serving http
// without calling Runlevel(3) you must
// connect via socket and issue the RUNLEVEL 3 command
s.Runlevel(3)
// serve forever
log.Fatalln(s.Wait())
See the examples
Read more:
CAUTION
API may change without notice! (it already has two times!)
Contributing
Submit new issue or pull request
Old version
import "gopkg.in/aerth/diamond.v1"
Documentation
¶
Overview ¶
Diamond package provides runlevels to an application
API is considered unstable until further notice
Index ¶
Constants ¶
const ( SINGLEUSER = 1 MULTIUSER = 3 )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Server ¶
type Server struct {
HookLevel0 func() []net.Listener
HookLevel1 func() []net.Listener
HookLevel2 func() []net.Listener
HookLevel3 func() []net.Listener
HookLevel4 func() []net.Listener
// contains filtered or unexported fields
}
Server ...
func New ¶
New creates a new Server, with a socket at socketpath, and starts listening.
Optional ptrs are pointers to types (`new(t)`) that contain methods Each given of given ptrs must satisfy the criteria in the net/rpc package See https://godoc.org/net/rpc for these criteria.
func (*Server) AddHTTPHandler ¶
AddHTTPHandler can restart, returns how many http handlers will be used (for shutdown and restarts)
func (*Server) AddListener ¶
AddListener listeners can only shutdown a port, not restart, returns total number of listeners (for shutdown)
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
diamond-admin
diamond-admin command for controlling a diamond daemon
|
diamond-admin command for controlling a diamond daemon |
|
simplesrv
serve files from single directory
|
serve files from single directory |
|
Diamond package provides runlevels to an application API is considered unstable until further notice
|
Diamond package provides runlevels to an application API is considered unstable until further notice |