service

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 13, 2019 License: AGPL-3.0 Imports: 6 Imported by: 1

Documentation

Overview

Package service wraps the grpcapi server to implement the gRPC-Web spec

Index

Constants

This section is empty.

Variables

View Source
var (
	// ErrNotGrpcServer is returned when the connected service is not a gRPC Server.
	ErrNotGrpcServer = errors.New("connected service is not a gRPC Server")

	// ErrUnavailable is returned from gRPC methods when the service is not
	// available.
	ErrUnavailable = errors.New("the service is not available")
)

Functions

This section is empty.

Types

type Config

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

	// Address is the address to bind to.
	Address string `toml:"address" comment:"Address to bind to."`
}

Config contains configuration options for the Clock service.

type Service

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

Service is the gRPC-Web service.

func (*Service) Config

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

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

func (*Service) Desc

func (s *Service) Desc() string

Desc returns a description of what the service does.

func (*Service) ID

func (s *Service) ID() string

ID returns the unique identifier of the service.

func (*Service) Name

func (s *Service) Name() string

Name returns the human friendly name of the service.

func (*Service) Needs

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

Needs returns the set of services this service depends on.

func (*Service) Plug

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

Plug sets the connected services.

func (*Service) Run

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

Run starts the service.

func (*Service) SetConfig

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

SetConfig configures the service.

Jump to

Keyboard shortcuts

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