sync

Documentation

Index

• type Option
  • func NewSyncOption(config conf.Config, users []*auth.User, r retry.Retry, pi ignore.PathIgnore, ...) Option
• type Sync
  • func NewDiskSync(opt Option) (s Sync, err error)
  • func NewEmptySync(opt Option) (s Sync, err error)
  • func NewMinIOPullClientSync(opt Option) (Sync, error)
  • func NewMinIOPushClientSync(opt Option) (Sync, error)
  • func NewPushClientSync(opt Option) (Sync, error)
  • func NewRemoteClientSync(opt Option) (Sync, error)
  • func NewRemoteServerSync(opt Option) (Sync, error)
  • func NewRemoteSync(opt Option) (Sync, error)
  • func NewSftpPullClientSync(opt Option) (Sync, error)
  • func NewSftpPushClientSync(opt Option) (Sync, error)
  • func NewSync(opt Option) (Sync, error)

Types

type Option

type Option struct {
	Source                core.VFS
	Dest                  core.VFS
	EnableHTTP3           bool
	FileServerAddr        string
	EnableTLS             bool
	TLSCertFile           string
	TLSKeyFile            string
	TLSInsecureSkipVerify bool
	EnableLogicallyDelete bool
	ChunkSize             int64
	CheckpointCount       int
	ForceChecksum         bool
	ChecksumAlgorithm     string
	Progress              bool
	MaxTranRate           int64
	DryRun                bool
	CopyLink              bool
	CopyUnsafeLink        bool
	TokenSecret           string
	Users                 []*auth.User
	Retry                 retry.Retry
	EncOpt                encrypt.Option
	PathIgnore            ignore.PathIgnore
	Reporter              report.Reporter
	TaskConf              string
	Logger                *logger.Logger
	SyncOnce              bool
	SyncCron              string
}

Option the sync component option

func NewSyncOption

func NewSyncOption(config conf.Config, users []*auth.User, r retry.Retry, pi ignore.PathIgnore, reporter report.Reporter, logger *logger.Logger) Option

NewSyncOption create an instance of the Option, store all the sync component options

type Sync

type Sync interface {
	// Create create the path
	Create(path string) error
	// Symlink create a symbolic link
	Symlink(oldname, newname string) error
	// Write write the data to path
	Write(path string) error
	// Remove remove the path
	Remove(path string) error
	// Rename rename the path
	Rename(path string) error
	// Chmod change the mode of path
	Chmod(path string) error
	// IsDir is a dir the path
	IsDir(path string) (bool, error)
	// SyncOnce sync the path to dest once
	SyncOnce(path string) error
	// Source the source file system
	Source() core.VFS
	// Dest the destination file system
	Dest() core.VFS
	// Close release the resource that is used by the sync component
	Close()
}

Sync a file sync interface

func NewDiskSync

func NewDiskSync(opt Option) (s Sync, err error)

NewDiskSync create a diskSync instance source is source path to read dest is dest path to write

func NewEmptySync

func NewEmptySync(opt Option) (s Sync, err error)

NewEmptySync create a emptySync instance

func NewMinIOPullClientSync

func NewMinIOPullClientSync(opt Option) (Sync, error)

NewMinIOPullClientSync create an instance of the minIOPullClientSync

func NewMinIOPushClientSync

func NewMinIOPushClientSync(opt Option) (Sync, error)

NewMinIOPushClientSync create an instance of the minIOPushClientSync

func NewPushClientSync

func NewPushClientSync(opt Option) (Sync, error)

NewPushClientSync create an instance of the pushClientSync

func NewRemoteClientSync

func NewRemoteClientSync(opt Option) (Sync, error)

NewRemoteClientSync create an instance of remoteClientSync to receive the file change message and execute it

func NewRemoteServerSync

func NewRemoteServerSync(opt Option) (Sync, error)

NewRemoteServerSync create an instance of remoteServerSync execute send file change message

func NewRemoteSync

func NewRemoteSync(opt Option) (Sync, error)

NewRemoteSync auto create an instance of remoteServerSync or remoteClientSync according to source and dest

func NewSftpPullClientSync

func NewSftpPullClientSync(opt Option) (Sync, error)

NewSftpPullClientSync create an instance of the sftpPullClientSync

func NewSftpPushClientSync

func NewSftpPushClientSync(opt Option) (Sync, error)

NewSftpPushClientSync create an instance of the sftpPushClientSync

func NewSync

func NewSync(opt Option) (Sync, error)

NewSync auto create an instance of the expected sync according to source and dest