common

package

v0.0.13 Latest Latest Go to latest Published: Feb 25, 2023 License: Apache-2.0 Imports: 14 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/infratographer/fertilesoil

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Server
- func NewServer(logger *zap.Logger, listen string, db *sql.DB, t storage.DirectoryAdmin, ...) *Server

Constants ¶

View Source

const (
	DefaultServerReadHeaderTimeout = 5 * time.Second
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Server ¶

type Server struct {
	DB *sql.DB
	T  storage.DirectoryAdmin
	L  *zap.Logger
	// contains filtered or unexported fields
}

func NewServer ¶

func NewServer(
	logger *zap.Logger,
	listen string,
	db *sql.DB,
	t storage.DirectoryAdmin,
	debug bool,
	shutdownTime time.Duration,
	unix string,
) *Server

func (*Server) AddReadinessCheck ¶

func (s *Server) AddReadinessCheck(name string, f ginx.CheckFunc) *Server

AddReadinessCheck will accept a function to be ran during calls to /readyx. These functions should accept a context and only return an error. When adding a readiness check a name is also provided, this name will be used when returning the state of all the checks.

func (*Server) DefaultEngine ¶

func (s *Server) DefaultEngine(logger *zap.Logger) *gin.Engine

func (*Server) Run ¶

func (s *Server) Run(ctx context.Context) error

Run will start the server.

func (*Server) SetHandler ¶

func (s *Server) SetHandler(h http.Handler)

func (*Server) Shutdown ¶

func (s *Server) Shutdown() error

Shutdown will gracefully shutdown the server.

Source Files ¶

View all Source files

common.go

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