model

Documentation

Overview

Package model implements folder abstraction and file pulling mechanisms

Index

• Constants
• type Availability
• type ConnectionInfo
  • func (info ConnectionInfo) MarshalJSON() ([]byte, error)
• type Model
  • func NewModel(cfg *config.Wrapper, id protocol.DeviceID, ...) *Model
  • func (m *Model) AddConnection(conn connections.Connection, hello protocol.HelloResult)
  • func (m *Model) AddFolder(cfg config.FolderConfiguration)
  • func (m *Model) Availability(folder, file string, version protocol.Vector, block protocol.BlockInfo) []Availability
  • func (m *Model) BringToFront(folder, file string)
  • func (m *Model) CheckFolderHealth(id string) error
  • func (m *Model) Close(device protocol.DeviceID, err error)
  • func (m *Model) ClusterConfig(deviceID protocol.DeviceID, cm protocol.ClusterConfig)
  • func (m *Model) CommitConfiguration(from, to config.Configuration) bool
  • func (m *Model) Completion(device protocol.DeviceID, folder string) float64
  • func (m *Model) ConnectedTo(deviceID protocol.DeviceID) bool
  • func (m *Model) ConnectionStats() map[string]interface{}
  • 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, bool)
  • func (m *Model) DelayScan(folder string, next time.Duration)
  • func (m *Model) DeviceStatistics() map[string]stats.DeviceStatistics
  • func (m *Model) DownloadProgress(device protocol.DeviceID, folder string, ...)
  • func (m *Model) FolderStatistics() map[string]stats.FolderStatistics
  • func (m *Model) GetHello(protocol.DeviceID) protocol.HelloIntf
  • func (m *Model) GetIgnores(folder string) ([]string, []string, error)
  • func (m *Model) GlobalDirectoryTree(folder, prefix string, levels int, dirsonly bool) map[string]interface{}
  • 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) IsPaused(device protocol.DeviceID) bool
  • func (m *Model) LocalSize(folder string) (nfiles, deleted int, bytes int64)
  • func (m *Model) NeedFolderFiles(folder string, page, perpage int) ([]db.FileInfoTruncated, []db.FileInfoTruncated, []db.FileInfoTruncated, int)
  • func (m *Model) NeedSize(folder string) (nfiles int, bytes int64)
  • func (m *Model) OnHello(remoteID protocol.DeviceID, addr net.Addr, hello protocol.HelloResult)
  • func (m *Model) Override(folder string)
  • func (m *Model) PauseDevice(device protocol.DeviceID)
  • func (m *Model) RemoteLocalVersion(folder string) (int64, bool)
  • func (m *Model) RemoveFolder(folder string)
  • func (m *Model) Request(deviceID protocol.DeviceID, folder, name string, offset int64, hash []byte, ...) error
  • func (m *Model) ResetFolder(folder string)
  • func (m *Model) ResumeDevice(device protocol.DeviceID)
  • func (m *Model) ScanFolder(folder string) error
  • func (m *Model) ScanFolderSubdirs(folder string, subs []string) error
  • func (m *Model) ScanFolders() map[string]error
  • func (m *Model) SetIgnores(folder string, content []string) error
  • func (m *Model) StartDeadlockDetector(timeout time.Duration)
  • func (m *Model) StartFolder(folder string)
  • func (m *Model) State(folder string) (string, time.Time, error)
  • func (m *Model) String() string
  • func (m *Model) VerifyConfiguration(from, to config.Configuration) error
• type ProgressEmitter
  • func NewProgressEmitter(cfg *config.Wrapper) *ProgressEmitter
  • func (t *ProgressEmitter) BytesCompleted(folder string) (bytes int64)
  • func (t *ProgressEmitter) CommitConfiguration(from, to config.Configuration) bool
  • func (t *ProgressEmitter) Deregister(s *sharedPullerState)
  • func (t *ProgressEmitter) Register(s *sharedPullerState)
  • func (t *ProgressEmitter) Serve()
  • func (t *ProgressEmitter) Stop()
  • func (t *ProgressEmitter) String() string
  • func (t *ProgressEmitter) VerifyConfiguration(from, to config.Configuration) error

Constants

const (
	FolderIdle folderState = iota
	FolderScanning
	FolderSyncing
	FolderError
)

Types

type Availability

type Availability struct {
	ID            protocol.DeviceID `json:"id"`
	FromTemporary bool              `json:"fromTemporary"`
}

type ConnectionInfo

type ConnectionInfo struct {
	protocol.Statistics
	Connected     bool
	Paused        bool
	Address       string
	ClientVersion string
	Type          string
}

func (ConnectionInfo) MarshalJSON

func (info ConnectionInfo) MarshalJSON() ([]byte, error)

type Model

type Model struct {
	*suture.Supervisor
	// contains filtered or unexported fields
}

func NewModel

func NewModel(cfg *config.Wrapper, id protocol.DeviceID, deviceName, clientName, clientVersion string, ldb *db.Instance, protectedFiles []string) *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(conn connections.Connection, hello protocol.HelloResult)

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) Availability

func (m *Model) Availability(folder, file string, version protocol.Vector, block protocol.BlockInfo) []Availability

func (*Model) BringToFront

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

BringToFront bumps the given files priority in the job queue.

func (*Model) CheckFolderHealth

func (m *Model) CheckFolderHealth(id string) error

CheckFolderHealth checks the folder for common errors and returns the current folder error, or nil if the folder is healthy.

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.ClusterConfig)

func (*Model) CommitConfiguration

func (m *Model) CommitConfiguration(from, to config.Configuration) bool

func (*Model) Completion

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

Completion 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]interface{}

ConnectionStats returns a map with connection statistics for each 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, bool)

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) DelayScan

func (m *Model) DelayScan(folder string, next time.Duration)

func (*Model) DeviceStatistics

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

DeviceStatistics returns statistics about each device

func (*Model) DownloadProgress

func (m *Model) DownloadProgress(device protocol.DeviceID, folder string, updates []protocol.FileDownloadProgressUpdate)

func (*Model) FolderStatistics

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

FolderStatistics returns statistics about each folder

func (*Model) GetHello

func (m *Model) GetHello(protocol.DeviceID) protocol.HelloIntf

GetHello is called when we are about to connect to some remote device.

func (*Model) GetIgnores

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

func (*Model) GlobalDirectoryTree

func (m *Model) GlobalDirectoryTree(folder, prefix string, levels int, dirsonly bool) map[string]interface{}

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) IsPaused

func (m *Model) IsPaused(device protocol.DeviceID) bool

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, page, perpage int) ([]db.FileInfoTruncated, []db.FileInfoTruncated, []db.FileInfoTruncated, int)

NeedFolderFiles returns paginated list of currently needed files in progress, queued, and to be queued on next puller iteration, as well as the total number of files currently needed.

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) OnHello

func (m *Model) OnHello(remoteID protocol.DeviceID, addr net.Addr, hello protocol.HelloResult)

OnHello is called when an device connects to us. This allows us to extract some information from the Hello message and add it to a list of known devices ahead of any checks.

func (*Model) Override

func (m *Model) Override(folder string)

func (*Model) PauseDevice

func (m *Model) PauseDevice(device protocol.DeviceID)

func (*Model) RemoteLocalVersion

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

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) RemoveFolder

func (m *Model) RemoveFolder(folder string)

func (*Model) Request

func (m *Model) Request(deviceID protocol.DeviceID, folder, name string, offset int64, hash []byte, fromTemporary bool, buf []byte) error

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

func (*Model) ResetFolder

func (m *Model) ResetFolder(folder string)

func (*Model) ResumeDevice

func (m *Model) ResumeDevice(device protocol.DeviceID)

func (*Model) ScanFolder

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

func (*Model) ScanFolderSubdirs

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

func (*Model) ScanFolders

func (m *Model) ScanFolders() map[string]error

func (*Model) SetIgnores

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

func (*Model) StartDeadlockDetector

func (m *Model) StartDeadlockDetector(timeout time.Duration)

StartDeadlockDetector starts a deadlock detector on the models locks which causes panics in case the locks cannot be acquired in the given timeout period.

func (*Model) StartFolder

func (m *Model) StartFolder(folder string)

StartFolder constructs the folder service and starts it.

func (*Model) State

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

func (*Model) String

func (m *Model) String() string

func (*Model) VerifyConfiguration

func (m *Model) VerifyConfiguration(from, to config.Configuration) error

type ProgressEmitter

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

func NewProgressEmitter

func NewProgressEmitter(cfg *config.Wrapper) *ProgressEmitter

NewProgressEmitter creates a new progress emitter which emits DownloadProgress events every interval.

func (*ProgressEmitter) BytesCompleted

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

BytesCompleted returns the number of bytes completed in the given folder.

func (*ProgressEmitter) CommitConfiguration

func (t *ProgressEmitter) CommitConfiguration(from, to config.Configuration) bool

CommitConfiguration implements the config.Committer interface

func (*ProgressEmitter) Deregister

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

Deregister a puller which will stop broadcasting 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()

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

func (*ProgressEmitter) Stop

func (t *ProgressEmitter) Stop()

Stop stops the emitter.

func (*ProgressEmitter) String

func (t *ProgressEmitter) String() string

func (*ProgressEmitter) VerifyConfiguration

func (t *ProgressEmitter) VerifyConfiguration(from, to config.Configuration) error

VerifyConfiguration implements the config.Committer interface