task

Documentation

Overview

Package task defines a synchronization task

Index

• type Sync
  • func NewSync(left model.Endpoint, right model.Endpoint, direction model.DirectionType) *Sync
  • func (s *Sync) BroadcastCloseSession(sessionUuid string)
  • func (s *Sync) Capture(ctx context.Context, targetFolder string) error
  • func (s *Sync) Pause(ctx context.Context)
  • func (s *Sync) ReApplyPatch(ctx context.Context, patch merger.Patch)
  • func (s *Sync) Resume(ctx context.Context)
  • func (s *Sync) RootStats(ctx context.Context, useSnapshots bool) (map[string]*model.EndpointRootStat, error)
  • func (s *Sync) Run(ctx context.Context, dryRun bool, force bool) (model.Stater, error)
  • func (s *Sync) SetFilters(roots []string, excludes []string)
  • func (s *Sync) SetPatchListener(listener merger.PatchListener)
  • func (s *Sync) SetSnapshotFactory(factory model.SnapshotFactory)
  • func (s *Sync) SetupCmd(cmd *model.Command)
  • func (s *Sync) SetupEventsChan(statusChan chan model.Status, batchDone chan interface{}, ...)
  • func (s *Sync) Shutdown()
  • func (s *Sync) Start(ctx context.Context, withWatches bool)

Types

type Sync

type Sync struct {
	Source           model.Endpoint
	Target           model.Endpoint
	Direction        model.DirectionType
	Roots            []string
	Ignores          []glob.Glob
	SkipTargetChecks bool
	// contains filtered or unexported fields
}

func NewSync

func NewSync(left model.Endpoint, right model.Endpoint, direction model.DirectionType) *Sync

NewSync creates a new sync task

func (*Sync) BroadcastCloseSession

func (s *Sync) BroadcastCloseSession(sessionUuid string)

BroadcastCloseSession forwards session id to underlying batchers

func (*Sync) Capture

func (s *Sync) Capture(ctx context.Context, targetFolder string) error

func (*Sync) Pause

func (s *Sync) Pause(ctx context.Context)

Pause should pause the sync

func (*Sync) ReApplyPatch

func (s *Sync) ReApplyPatch(ctx context.Context, patch merger.Patch)

func (*Sync) Resume

func (s *Sync) Resume(ctx context.Context)

Resume should resume the sync

func (*Sync) RootStats

func (s *Sync) RootStats(ctx context.Context, useSnapshots bool) (map[string]*model.EndpointRootStat, error)

func (*Sync) Run

func (s *Sync) Run(ctx context.Context, dryRun bool, force bool) (model.Stater, error)

Run runs the sync with panic recovery

func (*Sync) SetFilters

func (s *Sync) SetFilters(roots []string, excludes []string)

SetFilters allows passing selective roots (includes) and ignores (excludes). Ignores are a list of patterns conforming to the glob standard, with support for double star

func (*Sync) SetPatchListener

func (s *Sync) SetPatchListener(listener merger.PatchListener)

SetPatchListener adds a listener on the Patch channel to do something with patches before they are processed

func (*Sync) SetSnapshotFactory

func (s *Sync) SetSnapshotFactory(factory model.SnapshotFactory)

SetSnapshotFactory set up a factory for loading/saving snapshots

func (*Sync) SetupCmd

func (s *Sync) SetupCmd(cmd *model.Command)

func (*Sync) SetupEventsChan

func (s *Sync) SetupEventsChan(statusChan chan model.Status, batchDone chan interface{}, events chan interface{})

SetupEventsChan wires internal sync event to external status channels

func (*Sync) Shutdown

func (s *Sync) Shutdown()

Shutdown closes channels

func (*Sync) Start

func (s *Sync) Start(ctx context.Context, withWatches bool)

Start makes a first sync and setup watchers