serverpool

package

v0.0.0-...-ffea4ed Latest Latest Go to latest Published: Sep 1, 2021 License: Apache-2.0 Imports: 11 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/arjanvaneersel/kit

Links

Open Source Insights

Documentation ¶

Index ¶

type DiagnosticsServer
- func NewDiagnosticsServer(port int, l logger.Logger) *DiagnosticsServer
type Item
type Pool
- func New(l logger.Logger, items ...Item) *Pool
type Server
type Signaler

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type DiagnosticsServer ¶

type DiagnosticsServer struct {
	http.Server
	Router *mux.Router
	// contains filtered or unexported fields
}

func NewDiagnosticsServer ¶

func NewDiagnosticsServer(port int, l logger.Logger) *DiagnosticsServer

func (*DiagnosticsServer) Address ¶

func (s *DiagnosticsServer) Address() string

func (*DiagnosticsServer) Ready ¶

func (s *DiagnosticsServer) Ready(v bool)

func (*DiagnosticsServer) Start ¶

func (s *DiagnosticsServer) Start() error

func (*DiagnosticsServer) Stop ¶

func (s *DiagnosticsServer) Stop(ctx context.Context) error

type Item ¶

type Item struct {
	Name   string
	Server Server
}

Item contains a name and a Server implementation

type Pool ¶

type Pool struct {
	Items []Item
	// contains filtered or unexported fields
}

Pool is used to manage Server implementationsl. Pool contains functions to gracefully take care of starting and stopping multiple servers

func New ¶

func New(l logger.Logger, items ...Item) *Pool

func (*Pool) Ready ¶

func (p *Pool) Ready(v bool)

Ready is used to signal all relevant items that the pool is ready

func (*Pool) Start ¶

func (p *Pool) Start() (chan os.Signal, chan error)

Start will start all servers in the pool. It returns a channel for operating system signals and errors

func (*Pool) Stop ¶

func (p *Pool) Stop()

Stop loops over all items and executes a graceful shutdown with a timeout of 1 minute TODO: More flexible timeout

type Server ¶

type Server interface {
	// Start starts a server
	Start() error

	// Stop gracefully shutdsown a server
	Stop(context.Context) error

	// Address returns a string containing the address the server runs on
	Address() string
}

Server is an interface for servers which are to be used as a PoolItem

type Signaler ¶

type Signaler interface {
	Ready(bool)
}

Signaler is used for objects which require to be signalled when the server is ready

Source Files ¶

View all Source files

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