service

Documentation

Overview

Package service is a library which allows you to write well constructed Altid services

Overview

service aims to present a way to write canonical services, which behave correctly in all instances.

Index

• func UserConfDir() (string, error)
• func UserShareDir() (string, error)
• type Service
  • func New(name string, address string, debug bool) *Service
  • func (s *Service) Listen() error
  • func (s *Service) SetCommands(cmds []*commander.Command)
  • func (s *Service) WithCallbacks(cb callback.Callback)
  • func (s *Service) WithContext(ctx context.Context)
  • func (s *Service) WithListener(l listener.Listener)
  • func (s *Service) WithRunner(r runner.Runner)
  • func (s *Service) WithStore(st store.Filer)

Functions

func UserConfDir

func UserConfDir() (string, error)

UserConfDir returns the default root directory to use for user-specific configuration data. Users should create their own application-specific subdirectory within this one and use that. On Unix systems, it returns $XDG_CONFIG_HOME as specified by https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html if non-empty, else $HOME/.config. On Darwin, it returns $HOME/Library/Preferences. On Windows, it returns %LocalAppData%. On Plan 9, it returns $home/lib.

func UserShareDir

func UserShareDir() (string, error)

UserShareDir returns the default root directory to use for user-specific application data. Users should create their own application-specific subdirectory within this one and use that. On Unix systems, it returns $XDG_DATA_HOME as specified by https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html if non-empty, else $HOME/.local/share. On Darwin, it returns $HOME/Library. On Windows, it returns %LocalAppData%. On Plan 9, it returns $home/lib.

Types

type Service

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

func New

func New(name string, address string, debug bool) *Service

func (*Service) Listen

func (s *Service) Listen() error

func (*Service) SetCommands

func (s *Service) SetCommands(cmds []*commander.Command)

func (*Service) WithCallbacks

func (s *Service) WithCallbacks(cb callback.Callback)

func (*Service) WithContext

func (s *Service) WithContext(ctx context.Context)

func (*Service) WithListener

func (s *Service) WithListener(l listener.Listener)

func (*Service) WithRunner

func (s *Service) WithRunner(r runner.Runner)

func (*Service) WithStore

func (s *Service) WithStore(st store.Filer)