datasync

Documentation

Overview

Package datasync contains interfaces for syncing data from robots to the app.viam.com cloud.

Index

• Constants
• Variables
• type Manager
  • func NewManager(identity string, client v1.DataSyncServiceClient, logger logging.Logger, ...) (Manager, error)
  • func NewNoopManager() Manager
• type ManagerConstructor

Constants

const FailedDir = "failed"

FailedDir is a subdirectory of the capture directory that holds any files that could not be synced.

Variables

var (
	// InitialWaitTimeMillis defines the time to wait on the first retried upload attempt.
	InitialWaitTimeMillis = atomic.NewInt32(1000)
	// RetryExponentialFactor defines the factor by which the retry wait time increases.
	RetryExponentialFactor = atomic.NewInt32(2)
)

var MaxUnaryFileSize = int64(units.MB)

MaxUnaryFileSize is the max number of bytes to send using the unary DataCaptureUpload, as opposed to the StreamingDataCaptureUpload.

var UploadChunkSize = 64 * 1024

UploadChunkSize defines the size of the data included in each message of a FileUpload stream.

Types

type Manager

type Manager interface {
	SyncFile(path string)
	SetArbitraryFileTags(tags []string)
	Close()
}

Manager is responsible for enqueuing files in captureDir and uploading them to the cloud.

func NewManager

func NewManager(identity string, client v1.DataSyncServiceClient, logger logging.Logger, captureDir string) (Manager, error)

NewManager returns a new syncer.

func NewNoopManager

func NewNoopManager() Manager

NewNoopManager returns a noop sync manager that does nothing.

type ManagerConstructor

type ManagerConstructor func(identity string, client v1.DataSyncServiceClient, logger logging.Logger, captureDir string) (Manager, error)

ManagerConstructor is a function for building a Manager.