st

Documentation

Index

• Constants
• Variables
• type Event
• type Events
  • func (e *Events) Register(evName string, cb EventsCB, filterID string, data *EventsCBData) (string, error)
  • func (e *Events) Start() error
  • func (e *Events) Stop()
  • func (e *Events) UnRegister(id string) error
• type EventsCB
• type EventsCBData
• type ExitChan
• type FolderStatus
• type SyncThing
  • func NewSyncThing(conf *xdsconfig.Config, log *logrus.Logger) *SyncThing
  • func (s *SyncThing) ConfigGet() (config.Configuration, error)
  • func (s *SyncThing) ConfigSet(cfg config.Configuration) error
  • func (s *SyncThing) Connect() error
  • func (s *SyncThing) FolderChange(f xsapiv1.FolderConfig) (string, error)
  • func (s *SyncThing) FolderConfigGet(folderID string) (stconfig.FolderConfiguration, error)
  • func (s *SyncThing) FolderDelete(id string) error
  • func (s *SyncThing) FolderLoadFromStConfig(f *[]xsapiv1.FolderConfig) error
  • func (s *SyncThing) FolderScan(folderID string, subpath string) error
  • func (s *SyncThing) FolderStatus(folderID string) (*FolderStatus, error)
  • func (s *SyncThing) IDGet() (string, error)
  • func (s *SyncThing) IsConfigInSync() (bool, error)
  • func (s *SyncThing) IsFolderInSync(folderID string) (bool, error)
  • func (s *SyncThing) NewEventListener() *Events
  • func (s *SyncThing) Start() (*exec.Cmd, error)
  • func (s *SyncThing) StartInotify() (*exec.Cmd, error)
  • func (s *SyncThing) Stop()
  • func (s *SyncThing) StopInotify()
• type SyncthingEvent

Constants

const (
	// EventFolderCompletion .
	EventFolderCompletion string = "FolderCompletion"
	// EventFolderSummary .
	EventFolderSummary string = "FolderSummary"
	// EventFolderPaused .
	EventFolderPaused string = "FolderPaused"
	// EventFolderResumed .
	EventFolderResumed string = "FolderResumed"
	// EventFolderErrors .
	EventFolderErrors string = "FolderErrors"
	// EventStateChanged .
	EventStateChanged string = "StateChanged"
)

Variables

var EventsAll = EventFolderCompletion + "|" +
	EventFolderSummary + "|" +
	EventFolderPaused + "|" +
	EventFolderResumed + "|" +
	EventFolderErrors + "|" +
	EventStateChanged

EventsAll .

Types

type Event

type Event struct {
	Type string            `json:"type"`
	Time time.Time         `json:"time"`
	Data map[string]string `json:"data"`
}

Event Syncthing events structure

type Events

type Events struct {
	MonitorTime time.Duration
	Debug       bool
	// contains filtered or unexported fields
}

Events .

func (*Events) Register

func (e *Events) Register(evName string, cb EventsCB, filterID string, data *EventsCBData) (string, error)

Register Add a listener on an event

func (*Events) Start

func (e *Events) Start() error

Start starts event monitoring loop

func (*Events) Stop

func (e *Events) Stop()

Stop stops event monitoring loop

func (*Events) UnRegister

func (e *Events) UnRegister(id string) error

UnRegister Remove a listener event

type EventsCB

type EventsCB func(ev Event, cbData *EventsCBData)

EventsCB Event callback

type EventsCBData

type EventsCBData map[string]interface{}

EventsCBData Data parameter of Event callback

type ExitChan

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

ExitChan Channel used for process exit

type FolderStatus

type FolderStatus struct {
	GlobalFiles       int   `json:"globalFiles"`
	GlobalDirectories int   `json:"globalDirectories"`
	GlobalSymlinks    int   `json:"globalSymlinks"`
	GlobalDeleted     int   `json:"globalDeleted"`
	GlobalBytes       int64 `json:"globalBytes"`

	LocalFiles       int   `json:"localFiles"`
	LocalDirectories int   `json:"localDirectories"`
	LocalSymlinks    int   `json:"localSymlinks"`
	LocalDeleted     int   `json:"localDeleted"`
	LocalBytes       int64 `json:"localBytes"`

	NeedFiles       int   `json:"needFiles"`
	NeedDirectories int   `json:"needDirectories"`
	NeedSymlinks    int   `json:"needSymlinks"`
	NeedDeletes     int   `json:"needDeletes"`
	NeedBytes       int64 `json:"needBytes"`

	InSyncFiles int   `json:"inSyncFiles"`
	InSyncBytes int64 `json:"inSyncBytes"`

	State        string    `json:"state"`
	StateChanged time.Time `json:"stateChanged"`

	Sequence int64 `json:"sequence"`

	IgnorePatterns bool `json:"ignorePatterns"`
}

FolderStatus Information about the current status of a folder.

type SyncThing

type SyncThing struct {
	BaseURL   string
	APIKey    string
	Home      string
	STCmd     *exec.Cmd
	STICmd    *exec.Cmd
	MyID      string
	Connected bool
	Events    *Events
	// contains filtered or unexported fields
}

SyncThing .

func NewSyncThing

func NewSyncThing(conf *xdsconfig.Config, log *logrus.Logger) *SyncThing

NewSyncThing creates a new instance of Syncthing

func (*SyncThing) ConfigGet

func (s *SyncThing) ConfigGet() (config.Configuration, error)

ConfigGet returns the current Syncthing configuration

func (*SyncThing) ConfigSet

func (s *SyncThing) ConfigSet(cfg config.Configuration) error

ConfigSet set Syncthing configuration

func (*SyncThing) Connect

func (s *SyncThing) Connect() error

Connect Establish HTTP connection with Syncthing

func (*SyncThing) FolderChange

func (s *SyncThing) FolderChange(f xsapiv1.FolderConfig) (string, error)

FolderChange is called when configuration has changed

func (*SyncThing) FolderConfigGet

func (s *SyncThing) FolderConfigGet(folderID string) (stconfig.FolderConfiguration, error)

FolderConfigGet Returns the configuration of a specific folder

func (*SyncThing) FolderDelete

func (s *SyncThing) FolderDelete(id string) error

FolderDelete is called to delete a folder config

func (*SyncThing) FolderLoadFromStConfig

func (s *SyncThing) FolderLoadFromStConfig(f *[]xsapiv1.FolderConfig) error

FolderLoadFromStConfig Load/Retrieve folder config from syncthing database

func (*SyncThing) FolderScan

func (s *SyncThing) FolderScan(folderID string, subpath string) error

FolderScan Request immediate folder scan. Scan all folders if folderID param is empty

func (*SyncThing) FolderStatus

func (s *SyncThing) FolderStatus(folderID string) (*FolderStatus, error)

FolderStatus Returns all information about the current

func (*SyncThing) IDGet

func (s *SyncThing) IDGet() (string, error)

IDGet returns the Syncthing ID of Syncthing instance running locally

func (*SyncThing) IsConfigInSync

func (s *SyncThing) IsConfigInSync() (bool, error)

IsConfigInSync Returns true if configuration is in sync

func (*SyncThing) IsFolderInSync

func (s *SyncThing) IsFolderInSync(folderID string) (bool, error)

IsFolderInSync Returns true when folder is in sync

func (*SyncThing) NewEventListener

func (s *SyncThing) NewEventListener() *Events

NewEventListener Create a new instance of Event listener

func (*SyncThing) Start

func (s *SyncThing) Start() (*exec.Cmd, error)

Start Starts syncthing process

func (*SyncThing) StartInotify

func (s *SyncThing) StartInotify() (*exec.Cmd, error)

StartInotify Starts syncthing-inotify process

func (*SyncThing) Stop

func (s *SyncThing) Stop()

Stop Stops syncthing process

func (*SyncThing) StopInotify

func (s *SyncThing) StopInotify()

StopInotify Stops syncthing process

type SyncthingEvent

type SyncthingEvent struct {
	// Per-subscription sequential event ID. Named "id" for backwards compatibility with the REST API
	SubscriptionID int `json:"id"`
	// Global ID of the event across all subscriptions
	GlobalID int                    `json:"globalID"`
	Time     time.Time              `json:"time"`
	Type     string                 `json:"type"`
	Data     map[string]interface{} `json:"data"`
}

SyncthingEvent Syncthing Event structure definition