datasync

Documentation

Overview

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

Index

• Variables
• func NewClient(conn rpc.ClientConn) v1.DataSyncServiceClient
• func NewConnection(logger *zap.SugaredLogger, address string, rpcOpts []rpc.DialOption) (rpc.ClientConn, error)
• type Manager
  • func NewDefaultManager(logger golog.Logger, cfg *config.Config) (Manager, error)
  • func NewManager(logger golog.Logger, partID string, client v1.DataSyncServiceClient, ...) (Manager, error)
  • func NewNoopManager() Manager
• type ManagerConstructor

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 UploadChunkSize = 64 * 1024

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

Functions

func NewClient

func NewClient(conn rpc.ClientConn) v1.DataSyncServiceClient

NewClient constructs a new v1.DataSyncServiceClient using the passed in connection.

func NewConnection

func NewConnection(logger *zap.SugaredLogger, address string, rpcOpts []rpc.DialOption) (rpc.ClientConn, error)

NewConnection builds a connection to the passed address with the passed rpcOpts.

Types

type Manager

type Manager interface {
	SyncFile(path string)
	Close()
}

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

func NewDefaultManager

func NewDefaultManager(logger golog.Logger, cfg *config.Config) (Manager, error)

NewDefaultManager returns the default Manager that syncs data to app.viam.com.

func NewManager

func NewManager(logger golog.Logger, partID string, client v1.DataSyncServiceClient,
	conn rpc.ClientConn,
) (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(logger golog.Logger, cfg *config.Config) (Manager, error)

ManagerConstructor is a function for building a Manager.