service

package

v0.2.0 Latest Latest Go to latest Published: Mar 13, 2019 License: AGPL-3.0 Imports: 4 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

Package service defines a service that deals with setting NAT port mappings to allow nodes to connect to a node behind a firewall.

This section is empty.

View Source

var (
	// ErrNotHost is returned when the connected service is not a host.
	ErrNotHost = errors.New("connected service is not a host")
)

This section is empty.

type Config struct {
	// Host is the name of the host service.
	Host string `toml:"host" comment:"The name of the host service."`
}

Config contains configuration options for the NAT Manager service.

type Host interface {
	ihost.Host

	SetNATManager(bhost.NATManager)
}

Host represents a Stratumn Node host.

type Service struct {
	// contains filtered or unexported fields
}

Service is the NAT Manager service.

func (s *Service) Config() interface{}

Config returns the current service configuration or creates one with good default values.

func (s *Service) Desc() string

Desc returns a description of what the service does.

func (s *Service) Expose() interface{}

Expose exposes the NAT manager to other services.

It exposes thhe type:

github.com/libp2p/go-libp2p/p2p/host/basic.NATManager

func (s *Service) ID() string

ID returns the unique identifier of the service.

func (s *Service) Name() string

Name returns the human friendly name of the service.

func (s *Service) Needs() map[string]struct{}

Needs returns the set of services this service depends on.

func (s *Service) Plug(exposed map[string]interface{}) error

Plug sets the connected services.

func (s *Service) Run(ctx context.Context, running, stopping func()) error

Run starts the service.

func (s *Service) SetConfig(config interface{}) error

SetConfig configures the service.

Path	Synopsis
mockservice Package mockservice is a generated GoMock package.	Package mockservice is a generated GoMock package.