cloud

package
v0.23.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 15, 2024 License: AGPL-3.0 Imports: 9 Imported by: 0

Documentation

Overview

Package cloud implements a service to grab gRPC connections to talk to a cloud service that manages robots.

Index

Constants

View Source
const SubtypeName = "cloud_connection"

SubtypeName is a constant that identifies the internal cloud connection resource subtype string.

Variables

API is the fully qualified API for the internal cloud connection service.

View Source
var ErrNotCloudManaged = errors.New("this robot is not cloud managed")

ErrNotCloudManaged is returned if a connection is requested but the robot is not yet cloud managed.

View Source
var InternalServiceName = resource.NewName(API, "builtin")

InternalServiceName is used to refer to/depend on this service internally.

Functions

This section is empty.

Types

type ConnectionService

type ConnectionService interface {
	resource.Resource
	AcquireConnection(ctx context.Context) (string, rpc.ClientConn, error)
	AcquireConnectionAPIKey(ctx context.Context, apiKey, apiKeyID string) (string, rpc.ClientConn, error)
}

A ConnectionService supplies connections to a cloud service managing robots. Each connection should be closed when its not be used anymore.

func NewCloudConnectionService

func NewCloudConnectionService(cfg *config.Cloud, logger logging.Logger) ConnectionService

NewCloudConnectionService makes a new cloud connection service to get gRPC connections to a cloud service managing robots.

type Metadata added in v0.22.0

type Metadata struct {
	RobotPartID  string
	PrimaryOrgID string
	LocationID   string
}

Metadata contains app-related information about the robot.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL