server

Documentation

Overview

Package server implements Kopia API server handlers.

Index

• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetFile() http.FileSystem
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type Options
• type Server
  • func New(ctx context.Context, options Options) (*Server, error)
  • func (s *Server) APIHandlers() http.Handler
  • func (s *Server) SetRepository(ctx context.Context, rep repo.Repository) error
  • func (s *Server) StopAllSourceManagers(ctx context.Context)
  • func (s *Server) SyncSources(ctx context.Context) error

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetFile

func AssetFile() http.FileSystem

AssetFile return a http.FileSystem instance that data backend by asset.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory.

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively.

Types

type Options

type Options struct {
	ConfigFile      string
	ConnectOptions  *repo.ConnectOptions
	RefreshInterval time.Duration
}

Options encompasses all API server options.

type Server

type Server struct {
	OnShutdown func(ctx context.Context) error
	// contains filtered or unexported fields
}

Server exposes simple HTTP API for programmatically accessing Kopia features.

func New

func New(ctx context.Context, options Options) (*Server, error)

New creates a Server. The server will manage sources for a given username@hostname.

func (*Server) APIHandlers

func (s *Server) APIHandlers() http.Handler

APIHandlers handles API requests.

func (*Server) SetRepository

func (s *Server) SetRepository(ctx context.Context, rep repo.Repository) error

SetRepository sets the repository (nil is allowed and indicates server that is not connected to the repository).

func (*Server) StopAllSourceManagers

func (s *Server) StopAllSourceManagers(ctx context.Context)

StopAllSourceManagers causes all source managers to stop.

func (*Server) SyncSources

func (s *Server) SyncSources(ctx context.Context) error

SyncSources synchronizes the repository and source managers.