daemondefs

Documentation

Overview

Package daemondefs contains definitions used for the daemon.

It is a separate package so that packages that only depend on the daemon API does not need to depend on the concrete implementation.

Index

• type ActivateFunc
• type Client
• type SpawnConfig

Types

type ActivateFunc

type ActivateFunc func(stderr io.Writer, spawnCfg *SpawnConfig) (Client, error)

ActivateFunc is a function that activates a daemon client, possibly by spawning a new daemon and connecting to it.

type Client

type Client interface {
	storedefs.Store

	ResetConn() error
	Close() error

	Pid() (int, error)
	SockPath() string
	Version() (int, error)
}

Client represents a daemon client.

type SpawnConfig

type SpawnConfig struct {
	// DbPath is the path to the database.
	DbPath string
	// SockPath is the path to the socket on which the daemon will serve
	// requests.
	SockPath string
	// RunDir is the directory in which to place the daemon log file.
	RunDir string
}

SpawnConfig keeps configurations for spawning the daemon.