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 FindFirstName(r robot.Robot) string
• 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 FirstFromRobot(r robot.Robot) (Service, error)
  • func FromRobot(r robot.Robot, name string) (Service, error)
  • func New(_ context.Context, r robot.Robot, _ 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 Subtype = resource.NewSubtype(
	resource.ResourceNamespaceRDK,
	resource.ResourceTypeService,
	SubtypeName,
)

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

Functions

func FindFirstName

func FindFirstName(r robot.Robot) string

FindFirstName returns name of first data manager service found.

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 FirstFromRobot

func FirstFromRobot(r robot.Robot) (Service, error)

FirstFromRobot returns the first data manager service in this robot.

func FromRobot

func FromRobot(r robot.Robot, name string) (Service, error)

FromRobot is a helper for getting the named data manager service from the given Robot.

func New

func New(_ context.Context, r robot.Robot, _ 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.