repo

Documentation

Index

• Constants
• Variables
• func ConfigFilename(configroot string) (string, error)
• func Init(repoPath, swarmPort string) error
• type Datastore
• type FSRepo
  • func (r *FSRepo) Close() error
  • func (r *FSRepo) Config() (*config.Config, error)
  • func (r *FSRepo) Datastore() Datastore
  • func (r *FSRepo) Matrix() *matrix.MatrixKeeper
  • func (r *FSRepo) Path() string
  • func (r *FSRepo) SetState() error
  • func (r *FSRepo) State() *bloom.BloomFilter
  • func (r *FSRepo) StateKeeper() *StateKeeper
• type Repo
  • func Open(repoPath string) (Repo, error)
• type State
• type StateKeeper
  • func LoadStateKeeper(root string) (*StateKeeper, error)
  • func (s *StateKeeper) AddOrUpdateState(name string, membership bool, deltas []string) (*bloom.BloomFilter, error)
  • func (s *StateKeeper) GetState(name string) (*State, error)
  • func (s *StateKeeper) GetStates() map[string]*State
  • func (s *StateKeeper) SaveStates() (map[string]*State, error)

Constants

const (
	// Root location of the repository
	Root = ".datahop"
)

Variables

var (
	ErrorRepoClosed = errors.New("cannot access config, repo not open")
)

Functions

func ConfigFilename

func ConfigFilename(configroot string) (string, error)

ConfigFilename returns the configuration file path given a configuration root directory. If the configuration root directory is empty, use the default one

func Init

func Init(repoPath, swarmPort string) error

Init initialises ipfs persistent repository to a given location

Types

type Datastore

type Datastore interface {
	ds.Batching // must be thread-safe
}

Datastore is the interface required from a datastore to be acceptable to FSRepo.

type FSRepo

type FSRepo struct {
	io.Closer
	// contains filtered or unexported fields
}

FSRepo implements Repo

func (*FSRepo) Close

func (r *FSRepo) Close() error

Close repo

func (*FSRepo) Config

func (r *FSRepo) Config() (*config.Config, error)

Config returns repository config

func (*FSRepo) Datastore

func (r *FSRepo) Datastore() Datastore

Datastore returns datastore of the node

func (*FSRepo) Matrix

func (r *FSRepo) Matrix() *matrix.MatrixKeeper

Matrix returns nodes matrix

func (*FSRepo) Path

func (r *FSRepo) Path() string

Path of the repository

func (*FSRepo) SetState

func (r *FSRepo) SetState() error

SetState updates local state file with bloom filter

func (*FSRepo) State

func (r *FSRepo) State() *bloom.BloomFilter

State returns nodes crdt bloom filter state

func (*FSRepo) StateKeeper

func (r *FSRepo) StateKeeper() *StateKeeper

StateKeeper returns nodes matrix

type Repo

type Repo interface {
	Path() string
	Config() (*config.Config, error)
	Datastore() Datastore
	Close() error
	State() *bloom.BloomFilter
	SetState() error
	Matrix() *matrix.MatrixKeeper
	StateKeeper() *StateKeeper
}

Repo exposes basic repo operations

func Open

func Open(repoPath string) (Repo, error)

Open the FSRepo at path. Returns an error if the repo is not initialized.

type State

type State struct {
	Filter     *bloom.BloomFilter
	Membership bool
}

type StateKeeper

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

func LoadStateKeeper

func LoadStateKeeper(root string) (*StateKeeper, error)

func (*StateKeeper) AddOrUpdateState

func (s *StateKeeper) AddOrUpdateState(name string, membership bool, deltas []string) (*bloom.BloomFilter, error)

func (*StateKeeper) GetState

func (s *StateKeeper) GetState(name string) (*State, error)

func (*StateKeeper) GetStates

func (s *StateKeeper) GetStates() map[string]*State

func (*StateKeeper) SaveStates

func (s *StateKeeper) SaveStates() (map[string]*State, error)