datamanager

Documentation

Overview

Package datamanager contains a gRPC based datamanager service server

Package datamanager contains a service type that can be used to capture data from a robot's components.

Package datamanager contains a gRPC based datamanager service server

Index

• Constants
• Variables
• func Named(name string) resource.Name
• func NewServer(s subtype.Service) pb.DataManagerServiceServer
• func WrapWithReconfigurable(s interface{}) (resource.Reconfigurable, error)
• type Config
• type Service
  • func New(ctx context.Context, r robot.Robot, config config.Service, logger golog.Logger) (Service, error)
  • func NewClientFromConn(ctx context.Context, conn rpc.ClientConn, name string, logger golog.Logger) Service

Constants

const SubtypeName = resource.SubtypeName("data_manager")

SubtypeName is the name of the type of service.

Variables

var Name = resource.NameFromSubtype(Subtype, "")

Name is the DataManager's typed resource name.

var Subtype = resource.NewSubtype(
	resource.ResourceNamespaceRDK,
	resource.ResourceTypeService,
	SubtypeName,
)

Subtype is a constant that identifies the data manager service resource subtype.

Functions

func Named

func Named(name string) resource.Name

Named is a helper for getting the named datamanager's typed resource name. RSDK-347 Implements datamanager's Named.

func NewServer

func NewServer(s subtype.Service) pb.DataManagerServiceServer

NewServer constructs a datamanager gRPC service server.

func WrapWithReconfigurable

func WrapWithReconfigurable(s interface{}) (resource.Reconfigurable, error)

WrapWithReconfigurable wraps a data_manager as a Reconfigurable.

Types

type Config

type Config struct {
	CaptureDir            string   `json:"capture_dir"`
	AdditionalSyncPaths   []string `json:"additional_sync_paths"`
	SyncIntervalMins      float64  `json:"sync_interval_mins"`
	CaptureDisabled       bool     `json:"capture_disabled"`
	ScheduledSyncDisabled bool     `json:"sync_disabled"`
}

Config describes how to configure the service.

type Service

type Service interface {
	Sync(ctx context.Context) error
}

Service defines what a Data Manager Service should expose to the users.

func New

func New(ctx context.Context, r robot.Robot, config config.Service, logger golog.Logger) (Service, error)

New returns a new data manager service for the given robot.

func NewClientFromConn

func NewClientFromConn(ctx context.Context, conn rpc.ClientConn, name string, logger golog.Logger) Service

NewClientFromConn constructs a new Client from connection passed in.