README
¶
serverd
Package serverd provides a component to create server-type applications, helping to manage the life cycle of services and operating system signals.
It allows:
- Sequence startup and shutdown
- Set a timeout for shutdown and force stop
- Reload registered services
- Ping registered services for checking status
- Install signal handlers and manage interrupt and hup (reload) signals
Usage
See this simple example:
package main
import (
"context"
"log"
"net"
"net/http"
"github.com/luisguillenc/serverd"
"github.com/sirupsen/logrus"
)
func main() {
// init logger
logger := logrus.New()
logger.SetLevel(logrus.DebugLevel)
// creates serverd manager
srv := serverd.New(serverd.SetLogger(logger))
// creates first service
lis1, err := net.Listen("tcp", "127.0.0.1:8111")
if err != nil {
log.Fatalf("listening: %v", err)
}
http1 := &http.Server{}
// register first service
srv.Register(serverd.Service{
Name: "http1",
Start: func() error {
go http1.Serve(lis1)
return nil
},
Shutdown: func() { http1.Shutdown(context.Background()) },
})
// creates second service
lis2, err := net.Listen("tcp", "127.0.0.1:8112")
if err != nil {
log.Fatalf("listening: %v", err)
}
http2 := &http.Server{}
// register second service
srv.Register(serverd.Service{
Name: "http2",
Start: func() error {
go http2.Serve(lis2)
return nil
},
Shutdown: func() { http2.Shutdown(context.Background()) },
})
// run server
err = srv.Run()
if err != nil {
logger.Fatal(err)
}
}
Output with ctr+c:
$ go run main.go
INFO[0000] starting services
DEBU[0000] starting service http1
DEBU[0000] starting service http2
^CINFO[0003] shutting down services
DEBU[0003] shutting down service http2
DEBU[0003] shutting down service http1
Documentation
¶
Overview ¶
Package serverd provides a component to create server-type applications, helping to manage the life cycle of services and operating system signals.
This package is a work in progress and makes no API stability promises.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Manager ¶
type Manager struct {
// contains filtered or unexported fields
}
Manager is the component that manages the services
func (*Manager) Register ¶
Register resgisters a new service in the manager. Services cannot be registered if it has already been started.
func (*Manager) Run ¶
Run will initialize all services, install the operating system's signal handlers and block waiting for the shutdown signal. When this signal arrives, it will turn off all registered services.
type Option ¶
type Option func(*options)
Option is used for component configuration
func ShutdownTimeout ¶
ShutdownTimeout sets timeout for shutdowns
Source Files
Directories