service

package

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

Documentation ¶

Overview ¶

Package service defines types for the storage service.

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrFileNameMissing is returned when no file name was given.
	ErrFileNameMissing = errors.New("the first chunk should have the filename")

	// ErrUploadSessionNotFound is returned when no upload session could be found.
	ErrUploadSessionNotFound = errors.New("the given session was not found")

	// ErrInvalidUploadSession is returned when the session id could not be parsed.
	ErrInvalidUploadSession = errors.New("the given session could not be parsed")
)

View Source

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

	// 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.
	Host string `toml:"host" comment:"The name of the host service."`

	// Path to the local storage folder.
	LocalStorage string `toml:"local_storage" comment:"The path to the local storage."`

	// DbPath is the path to the database used for file hashes and permissions.
	DbPath string `toml:"db_path" comment:"The path to the database used for the state and the chain."`

	// UploadTimeout is the time after which an upload session will be reset (and the partial file deleted).
	UploadTimeout string `toml:"upload_timeout" comment:"The time after which an upload session will be reset (and the partial file deleted)"`
}

Config contains configuration options for the Storage service.

type Host ¶

type Host = ihost.Host

Host represents a Stratumn Node host.

type Service ¶

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

Service is the Storage service.

func (*Service) AddToGRPCServer ¶

func (s *Service) AddToGRPCServer(gs *grpc.Server)

AddToGRPCServer adds the service to a gRPC server.

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) Expose ¶

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

Expose exposes the storage service to other services. It is currently not exposed.

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(services 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 handler.

Source Files ¶

View all Source files

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