action

Documentation

Overview

Package action implements the viam-labs.services.action API

Index

• Variables
• func Named(name string) resource.Name
• func NewRPCServiceServer(coll resource.APIResourceCollection[Action]) interface{}
• type Action
  • func FromRobot(r robot.Robot, name string) (Action, error)
  • func NewClientFromConn(conn rpc.ClientConn, remoteName string, name resource.Name, ...) Action

Variables

var API = resource.APINamespace("viam-labs").WithServiceType("action")

API is the full API definition.

Functions

func Named

func Named(name string) resource.Name

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

func NewRPCServiceServer

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

NewRPCServiceServer returns a new RPC server for the Action API.

Types

type Action

type Action interface {
	resource.Resource
	Start(ctx context.Context) error
	Stop(ctx context.Context) error
	IsRunning(ctx context.Context) (bool, error)
	Status(ctx context.Context) (map[string]*structpb.Value, error)
}

Action defines the Go interface for the component (should match the protobuf methods.)

func FromRobot

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

FromRobot is a helper for getting the named Action from the given Robot.

func NewClientFromConn

func NewClientFromConn(conn rpc.ClientConn, remoteName string, name resource.Name, logger logging.Logger) Action

NewClientFromConn creates a new Action RPC client from an existing connection.