grace

package

v1.1.2 Latest Latest Go to latest Published: Sep 18, 2022 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/alhamsya/boilerplate-go

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ServeCron(app *cron.Cron, graceTimeout time.Duration) error
func ServeGRPC(server GRPCServer, address string, graceTimeout time.Duration) error
func ServeREST(srv HTTPServer, address string, graceTimeout time.Duration) error
func ServeRESTWithFiber(app *fiber.App, address string, graceTimeout time.Duration) error
func WaitTermSig(handler func(context.Context) error) <-chan struct{}
type GRPCServer
type HTTPServer

Constants ¶

View Source

const ProtocolTCP4 = "tcp4"

Variables ¶

This section is empty.

Functions ¶

func ServeCron ¶

func ServeCron(app *cron.Cron, graceTimeout time.Duration) error

ServeCron start the cron server on the given app and add graceful shutdown handler

func ServeGRPC ¶

func ServeGRPC(server GRPCServer, address string, graceTimeout time.Duration) error

ServeGRPC start the gRPC server on the given address and add graceful shutdown handler

func ServeREST ¶

func ServeREST(srv HTTPServer, address string, graceTimeout time.Duration) error

ServeREST start the http server on the given address and add graceful shutdown handler

func ServeRESTWithFiber ¶

func ServeRESTWithFiber(app *fiber.App, address string, graceTimeout time.Duration) error

ServeRESTWithFiber start the http server using fiber on the given address and add graceful shutdown handler

func WaitTermSig ¶

func WaitTermSig(handler func(context.Context) error) <-chan struct{}

WaitTermSig wait for termination signal and then execute the given handler The handler is usually transport shutdown, so we can properly shutdown our server upon SIGTERM. It returns channel which will be closed after the signal received and the handler executed. We can use the signal to wait for the shutdown to be finished.

Types ¶

type GRPCServer ¶

type GRPCServer interface {
	GracefulStop()
	Stop()
	Serve(l net.Listener) error
}

GRPCServer represents interface for grpc server

type HTTPServer ¶

type HTTPServer interface {
	Shutdown(ctx context.Context) error
	Serve(l net.Listener) error
}

HTTPServer represents an HTTP server

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL