subject

Documentation

Overview

Package subject holds the code for handling tracable applications in the robot system.

Index

• func Serve(ctx context.Context, grpcServer *grpc.Server, subjects Subjects) error
• type Handler
• type Subjects
  • func NewLocal(ctx context.Context, library record.Library, store *stash.Client) (Subjects, error)
  • func NewRemote(ctx context.Context, conn *grpc.ClientConn) Subjects

Functions

func Serve

func Serve(ctx context.Context, grpcServer *grpc.Server, subjects Subjects) error

Serve wraps a subject service in a grpc server.

Types

type Handler

type Handler func(context.Context, *Subject) error

Handler is a function that handles a stream of Subjects.

type Subjects

type Subjects interface {
	// Search returns a iterator of matching subjects from the store.
	Search(context.Context, *search.Query, Handler) error
	// Add adds a new subject to the set.
	Add(ctx context.Context, id string, obbID string, hints *Hints) (*Subject, bool, error)
	// Update changes the values of a subject.
	Update(ctx context.Context, subj *Subject) (*Subject, error)
}

Subjects is the interface to a subject manager.

func NewLocal

func NewLocal(ctx context.Context, library record.Library, store *stash.Client) (Subjects, error)

NewLocal returns a new persistent store of Subjects.

func NewRemote

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

NewRemote returns a Subjects that talks to a remote grpc Subject service.