generic

Documentation

Overview

Package generic contains a gRPC based generic client.

Package generic defines an abstract generic device and DoCommand() method. For more information, see the generic component docs.

Package generic contains a gRPC based generic service serviceServer.

Index

• Constants
• Variables
• func FromRobot(r robot.Robot, name string) (resource.Resource, error)
• func Named(name string) resource.Name
• func NamesFromRobot(r robot.Robot) []string
• func NewClientFromConn(ctx context.Context, conn rpc.ClientConn, remoteName string, ...) (resource.Resource, error)
• func NewRPCServiceServer(coll resource.APIResourceCollection[resource.Resource]) interface{}

Constants

const SubtypeName = "generic"

SubtypeName is a constant that identifies the component resource API string "Generic".

Variables

var API = resource.APINamespaceRDK.WithComponentType(SubtypeName)

API is a variable that identifies the component resource API.

Functions

func FromRobot

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

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

func Named

func Named(name string) resource.Name

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

func NamesFromRobot

func NamesFromRobot(r robot.Robot) []string

NamesFromRobot is a helper for getting all generic names from the given Robot.

func NewClientFromConn

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

NewClientFromConn constructs a new Client from connection passed in.

func NewRPCServiceServer

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

NewRPCServiceServer constructs an generic gRPC service serviceServer.