shell

package

v0.26.0 Latest Latest Go to latest Published: Apr 29, 2024 License: AGPL-3.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/viamrobotics/rdk

Links

Open Source Insights

Documentation ¶

Overview ¶

Package shell contains a shell service, along with a gRPC server and client

Index ¶

Constants
Variables
func Named(name string) resource.Name
func NewRPCServiceServer(coll resource.APIResourceCollection[Service]) interface{}
type Output
type Service
- func NewClientFromConn(ctx context.Context, conn rpc.ClientConn, remoteName string, ...) (Service, error)

Constants ¶

View Source

const SubtypeName = "shell"

SubtypeName is the name of the type of service.

Variables ¶

View Source

var API = resource.APINamespaceRDK.WithServiceType(SubtypeName)

API is a variable that identifies the shell service resource API.

Functions ¶

func Named ¶ added in v0.0.8

func Named(name string) resource.Name

Named is a helper for getting the named service's typed resource name.

func NewRPCServiceServer ¶ added in v0.2.36

func NewRPCServiceServer(coll resource.APIResourceCollection[Service]) interface{}

NewRPCServiceServer constructs a framesystem gRPC service server. It is intentionally untyped to prevent use outside of tests.

Types ¶

type Output ¶

type Output struct {
	Output string // reflects stdout
	Error  string // reflects stderr
	EOF    bool
}

Output reflects an instance of shell output on either stdout or stderr.

type Service ¶

type Service interface {
	resource.Resource
	Shell(ctx context.Context, extra map[string]interface{}) (
		input chan<- string, oobInput chan<- map[string]interface{}, output <-chan Output, retErr error)
}

A Service handles shells for a local robot.

func NewClientFromConn ¶

func NewClientFromConn(
	ctx context.Context,
	conn rpc.ClientConn,
	remoteName string,
	name resource.Name,
	logger logging.Logger,
) (Service, error)

NewClientFromConn constructs a new Client from connection passed in.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
builtin Package builtin contains a shell service, along with a gRPC server and client	Package builtin contains a shell service, along with a gRPC server and client
register Package register registers all relevant shell models and also API specific functions	Package register registers all relevant shell models and also API specific functions

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