startstop

package module

v0.0.0-...-bc15841 Latest Latest Go to latest Published: Oct 13, 2016 License: BSD-3-Clause Imports: 4 Imported by: 10

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/facebookgo/startstop

Links

Open Source Insights

README ¶

startstop

Documentation: https://godoc.org/github.com/facebookgo/startstop

Documentation ¶

Overview ¶

Package startstop provides automatic Start/Stop for inject eliminating the necessity for manual ordering.

Index ¶

func Start(objects []*inject.Object, log Logger) error
func Stop(objects []*inject.Object, log Logger) error
func TryStart(objects []*inject.Object, log Logger) ([]*inject.Object, error)
type Closer
type Logger
type Opener
type Starter
type Stopper

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Start ¶

func Start(objects []*inject.Object, log Logger) error

Start the graph, in the right order. Start will call Start or Open if an object satisfies the associated interface.

func Stop ¶

func Stop(objects []*inject.Object, log Logger) error

Stop the graph, in the right order. Stop will call Stop or Close if an object satisfies the associated interface.

func TryStart ¶

func TryStart(objects []*inject.Object, log Logger) ([]*inject.Object, error)

TryStart will start the graph, in the right order. It will call Start or Open. It returns the list of objects that have been successfully started. This can be used to stop only the dependencies that have been correctly started.

Types ¶

type Closer ¶

type Closer interface {
	Close() error
}

Closer defines the Close method, objects satisfying this interface will be closed by Stop.

type Logger ¶

type Logger interface {
	Debugf(f string, args ...interface{})
	Errorf(f string, args ...interface{})
}

Logger is used by Start/Stop to provide debug and error logging.

type Opener ¶

type Opener interface {
	Open() error
}

Opener defines the Open method, objects satisfying this interface will be opened by Start.

type Starter ¶

type Starter interface {
	Start() error
}

Starter defines the Start method, objects satisfying this interface will be started by Start.

type Stopper ¶

type Stopper interface {
	Stop() error
}

Stopper defines the Stop method, objects satisfying this interface will be stopped by Stop.

Source Files ¶

View all Source files

startstop.go

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