report

Documentation

Overview

Package report holds the functionality for running trace reports and verifying correctness of a trace in the robot system.

Index

• func Run(ctx context.Context, store *stash.Client, manager Manager, tempDir file.Path) error
• func Serve(ctx context.Context, grpcServer *grpc.Server, manager Manager) error
• type ActionHandler
• type Manager
  • func NewLocal(ctx context.Context, library record.Library, jobManager job.Manager) (Manager, error)
  • func NewRemote(ctx context.Context, conn *grpc.ClientConn) Manager
• type TaskHandler

Functions

func Run

func Run(ctx context.Context, store *stash.Client, manager Manager, tempDir file.Path) error

Run starts new report client if any hardware is available.

func Serve

func Serve(ctx context.Context, grpcServer *grpc.Server, manager Manager) error

Serve wraps a manager in a grpc server.

Types

type ActionHandler

type ActionHandler func(context.Context, *Action) error

ActionHandler is a function that handles a stream of Actions.

type Manager

type Manager interface {
	// Search invokes handler with each output that matches the query.
	Search(ctx context.Context, query *search.Query, handler ActionHandler) error
	// Register a handler that will accept incoming tasks.
	Register(ctx context.Context, host *device.Instance, target *device.Instance, handler TaskHandler) error
	// Do asks the manager to send a task to a device.
	Do(ctx context.Context, device string, input *Input) (string, error)
	// Update adjusts the state of an action.
	Update(ctx context.Context, action string, status job.Status, output *Output) error
}

Manager is the interface to a trace manager.

func NewLocal

func NewLocal(ctx context.Context, library record.Library, jobManager job.Manager) (Manager, error)

NewLocal builds a new local manager.

func NewRemote

func NewRemote(ctx context.Context, conn *grpc.ClientConn) Manager

NewRemote returns a Worker that talks to a remote grpc report service.

type TaskHandler

type TaskHandler func(context.Context, *Task) error

TaskHandler is a function that handles a stream of Tasks.