shell

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 NewServer(s subtype.Service) pb.ShellServiceServer
• func WrapWithReconfigurable(s interface{}) (resource.Reconfigurable, error)
• type Output
• type Service
  • func New(logger golog.Logger) (Service, error)
  • func NewClientFromConn(ctx context.Context, conn rpc.ClientConn, name string, logger golog.Logger) Service

Constants

const SubtypeName = resource.SubtypeName("shell")

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 shell service resource subtype.

Functions

func Named

func Named(name string) resource.Name

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

func NewServer

func NewServer(s subtype.Service) pb.ShellServiceServer

NewServer constructs a framesystem gRPC service server.

func WrapWithReconfigurable

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

WrapWithReconfigurable wraps a shell service as a Reconfigurable.

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 {
	Shell(ctx context.Context) (input chan<- string, output <-chan Output, retErr error)
}

A Service handles shells for a local robot.

func New

func New(logger golog.Logger) (Service, error)

New returns a new shell 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.