model

Documentation

Overview

Package model implements folder abstraction and file pulling mechanisms

Index

• Constants
• Variables
• type ConnectionInfo
• type Model
  • func NewModel(cfg *config.Wrapper, deviceName, clientName, clientVersion string, ...) *Model
  • func (m *Model) AddConnection(rawConn io.Closer, protoConn protocol.Connection)
  • func (m *Model) AddFolder(cfg config.FolderConfiguration)
  • func (m *Model) BringToFront(folder, file string)
  • func (m *Model) Close(device protocol.DeviceID, err error)
  • func (m *Model) ClusterConfig(deviceID protocol.DeviceID, cm protocol.ClusterConfigMessage)
  • func (m *Model) Completion(device protocol.DeviceID, folder string) float64
  • func (m *Model) ConnectedTo(deviceID protocol.DeviceID) bool
  • func (m *Model) ConnectionStats() map[string]ConnectionInfo
  • func (m *Model) CurrentFolderFile(folder string, file string) (protocol.FileInfo, bool)
  • func (m *Model) CurrentGlobalFile(folder string, file string) (protocol.FileInfo, bool)
  • func (m *Model) CurrentLocalVersion(folder string) int64
  • func (m *Model) DeviceStatistics() map[string]stats.DeviceStatistics
  • func (m *Model) FolderStatistics() map[string]stats.FolderStatistics
  • func (m *Model) GetIgnores(folder string) ([]string, []string, error)
  • func (m *Model) GlobalSize(folder string) (nfiles, deleted int, bytes int64)
  • func (m *Model) Index(deviceID protocol.DeviceID, folder string, fs []protocol.FileInfo)
  • func (m *Model) IndexUpdate(deviceID protocol.DeviceID, folder string, fs []protocol.FileInfo)
  • func (m *Model) LocalSize(folder string) (nfiles, deleted int, bytes int64)
  • func (m *Model) NeedFolderFiles(folder string, max int) ([]db.FileInfoTruncated, []db.FileInfoTruncated, []db.FileInfoTruncated)
  • func (m *Model) NeedSize(folder string) (nfiles int, bytes int64)
  • func (m *Model) Override(folder string)
  • func (m *Model) RemoteLocalVersion(folder string) int64
  • func (m *Model) ReplaceLocal(folder string, fs []protocol.FileInfo)
  • func (m *Model) Request(deviceID protocol.DeviceID, folder, name string, offset int64, size int) ([]byte, error)
  • func (m *Model) ScanFolder(folder string) error
  • func (m *Model) ScanFolderSub(folder, sub string) error
  • func (m *Model) ScanFolders()
  • func (m *Model) SetIgnores(folder string, content []string) error
  • func (m *Model) StartFolderRO(folder string)
  • func (m *Model) StartFolderRW(folder string)
  • func (m *Model) State(folder string) (string, time.Time)
  • func (m *Model) String() string
• type ProgressEmitter
  • func NewProgressEmitter(cfg *config.Wrapper) *ProgressEmitter
  • func (t *ProgressEmitter) BytesCompleted(folder string) (bytes int64)
  • func (t *ProgressEmitter) Changed(cfg config.Configuration) error
  • func (t *ProgressEmitter) Deregister(s *sharedPullerState)
  • func (t *ProgressEmitter) Register(s *sharedPullerState)
  • func (t *ProgressEmitter) Serve()
  • func (t *ProgressEmitter) Stop()
• type Puller
  • func (p *Puller) BringToFront(filename string)
  • func (p *Puller) Jobs() ([]string, []string)
  • func (p *Puller) Serve()
  • func (p *Puller) Stop()
  • func (p *Puller) String() string
• type Scanner
  • func (s *Scanner) BringToFront(string)
  • func (s *Scanner) Jobs() ([]string, []string)
  • func (s *Scanner) Serve()
  • func (s *Scanner) Stop()
  • func (s *Scanner) String() string

Constants

const (
	FolderIdle folderState = iota
	FolderScanning
	FolderSyncing
	FolderCleaning
)

const (
	IndexPerBlockSize = 40 // Each BlockInfo is approximately this big

)

How many files to send in each Index/IndexUpdate message.

Variables

var (
	ErrNoSuchFile = errors.New("no such file")
	ErrInvalid    = errors.New("file is invalid")

	SymlinkWarning = sync.Once{}
)

Types

type ConnectionInfo

type ConnectionInfo struct {
	protocol.Statistics
	Address       string
	ClientVersion string
}

type Model

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

func NewModel

func NewModel(cfg *config.Wrapper, deviceName, clientName, clientVersion string, ldb *leveldb.DB) *Model

NewModel creates and starts a new model. The model starts in read-only mode, where it sends index information to connected peers and responds to requests for file data without altering the local folder in any way.

func (*Model) AddConnection

func (m *Model) AddConnection(rawConn io.Closer, protoConn protocol.Connection)

AddConnection adds a new peer connection to the model. An initial index will be sent to the connected peer, thereafter index updates whenever the local folder changes.

func (*Model) AddFolder

func (m *Model) AddFolder(cfg config.FolderConfiguration)

func (*Model) BringToFront

func (m *Model) BringToFront(folder, file string)

Bump the given files priority in the job queue

func (*Model) Close

func (m *Model) Close(device protocol.DeviceID, err error)

Close removes the peer from the model and closes the underlying connection if possible. Implements the protocol.Model interface.

func (*Model) ClusterConfig

func (m *Model) ClusterConfig(deviceID protocol.DeviceID, cm protocol.ClusterConfigMessage)

func (*Model) Completion

func (m *Model) Completion(device protocol.DeviceID, folder string) float64

Returns the completion status, in percent, for the given device and folder.

func (*Model) ConnectedTo

func (m *Model) ConnectedTo(deviceID protocol.DeviceID) bool

ConnectedTo returns true if we are connected to the named device.

func (*Model) ConnectionStats

func (m *Model) ConnectionStats() map[string]ConnectionInfo

ConnectionStats returns a map with connection statistics for each connected device.

func (*Model) CurrentFolderFile

func (m *Model) CurrentFolderFile(folder string, file string) (protocol.FileInfo, bool)

func (*Model) CurrentGlobalFile

func (m *Model) CurrentGlobalFile(folder string, file string) (protocol.FileInfo, bool)

func (*Model) CurrentLocalVersion

func (m *Model) CurrentLocalVersion(folder string) int64

CurrentLocalVersion returns the change version for the given folder. This is guaranteed to increment if the contents of the local folder has changed.

func (*Model) DeviceStatistics

func (m *Model) DeviceStatistics() map[string]stats.DeviceStatistics

Returns statistics about each device

func (*Model) FolderStatistics

func (m *Model) FolderStatistics() map[string]stats.FolderStatistics

Returns statistics about each folder

func (*Model) GetIgnores

func (m *Model) GetIgnores(folder string) ([]string, []string, error)

func (*Model) GlobalSize

func (m *Model) GlobalSize(folder string) (nfiles, deleted int, bytes int64)

GlobalSize returns the number of files, deleted files and total bytes for all files in the global model.

func (*Model) Index

func (m *Model) Index(deviceID protocol.DeviceID, folder string, fs []protocol.FileInfo)

Index is called when a new device is connected and we receive their full index. Implements the protocol.Model interface.

func (*Model) IndexUpdate

func (m *Model) IndexUpdate(deviceID protocol.DeviceID, folder string, fs []protocol.FileInfo)

IndexUpdate is called for incremental updates to connected devices' indexes. Implements the protocol.Model interface.

func (*Model) LocalSize

func (m *Model) LocalSize(folder string) (nfiles, deleted int, bytes int64)

LocalSize returns the number of files, deleted files and total bytes for all files in the local folder.

func (*Model) NeedFolderFiles

func (m *Model) NeedFolderFiles(folder string, max int) ([]db.FileInfoTruncated, []db.FileInfoTruncated, []db.FileInfoTruncated)

NeedFiles returns the list of currently needed files in progress, queued, and to be queued on next puller iteration. Also takes a soft cap which is only respected when adding files from the model rather than the runner queue.

func (*Model) NeedSize

func (m *Model) NeedSize(folder string) (nfiles int, bytes int64)

NeedSize returns the number and total size of currently needed files.

func (*Model) Override

func (m *Model) Override(folder string)

func (*Model) RemoteLocalVersion

func (m *Model) RemoteLocalVersion(folder string) int64

RemoteLocalVersion returns the change version for the given folder, as sent by remote peers. This is guaranteed to increment if the contents of the remote or global folder has changed.

func (*Model) ReplaceLocal

func (m *Model) ReplaceLocal(folder string, fs []protocol.FileInfo)

ReplaceLocal replaces the local folder index with the given list of files.

func (*Model) Request

func (m *Model) Request(deviceID protocol.DeviceID, folder, name string, offset int64, size int) ([]byte, error)

Request returns the specified data segment by reading it from local disk. Implements the protocol.Model interface.

func (*Model) ScanFolder

func (m *Model) ScanFolder(folder string) error

func (*Model) ScanFolderSub

func (m *Model) ScanFolderSub(folder, sub string) error

func (*Model) ScanFolders

func (m *Model) ScanFolders()

func (*Model) SetIgnores

func (m *Model) SetIgnores(folder string, content []string) error

func (*Model) StartFolderRO

func (m *Model) StartFolderRO(folder string)

StartRO starts read only processing on the current model. When in read only mode the model will announce files to the cluster but not pull in any external changes.

func (*Model) StartFolderRW

func (m *Model) StartFolderRW(folder string)

StartRW starts read/write processing on the current model. When in read/write mode the model will attempt to keep in sync with the cluster by pulling needed files from peer devices.

func (*Model) State

func (m *Model) State(folder string) (string, time.Time)

func (*Model) String

func (m *Model) String() string

type ProgressEmitter

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

func NewProgressEmitter

func NewProgressEmitter(cfg *config.Wrapper) *ProgressEmitter

Creates a new progress emitter which emits DownloadProgress events every interval.

func (*ProgressEmitter) BytesCompleted

func (t *ProgressEmitter) BytesCompleted(folder string) (bytes int64)

Returns number of bytes completed in the given folder.

func (*ProgressEmitter) Changed

func (t *ProgressEmitter) Changed(cfg config.Configuration) error

Interface method to handle configuration changes

func (*ProgressEmitter) Deregister

func (t *ProgressEmitter) Deregister(s *sharedPullerState)

Deregister a puller which will stop boardcasting pullers state.

func (*ProgressEmitter) Register

func (t *ProgressEmitter) Register(s *sharedPullerState)

Register a puller with the emitter which will start broadcasting pullers progress.

func (*ProgressEmitter) Serve

func (t *ProgressEmitter) Serve()

Starts progress emitter which starts emitting DownloadProgress events as the progress happens.

func (*ProgressEmitter) Stop

func (t *ProgressEmitter) Stop()

Stops the emitter.

type Puller

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

func (*Puller) BringToFront

func (p *Puller) BringToFront(filename string)

Moves the given filename to the front of the job queue

func (*Puller) Jobs

func (p *Puller) Jobs() ([]string, []string)

func (*Puller) Serve

func (p *Puller) Serve()

Serve will run scans and pulls. It will return when Stop()ed or on a critical error.

func (*Puller) Stop

func (p *Puller) Stop()

func (*Puller) String

func (p *Puller) String() string

type Scanner

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

func (*Scanner) BringToFront

func (s *Scanner) BringToFront(string)

func (*Scanner) Jobs

func (s *Scanner) Jobs() ([]string, []string)

func (*Scanner) Serve

func (s *Scanner) Serve()

func (*Scanner) Stop

func (s *Scanner) Stop()

func (*Scanner) String

func (s *Scanner) String() string