gizmoapi

Documentation

Overview

Package gizmoapi implements the acme:component:gizmo API, a demonstraction API showcasing the available GRPC method types.

Index

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

Variables

var API = resource.APINamespace("acme").WithComponentType("gizmo")

API is the full API definition.

Functions

func Named

func Named(name string) resource.Name

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

func NewRPCServiceServer

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

NewRPCServiceServer returns a new RPC server for the gizmo API.

Types

type Gizmo

type Gizmo interface {
	resource.Resource
	DoOne(ctx context.Context, arg1 string) (bool, error)
	DoOneClientStream(ctx context.Context, arg1 []string) (bool, error)
	DoOneServerStream(ctx context.Context, arg1 string) ([]bool, error)
	DoOneBiDiStream(ctx context.Context, arg1 []string) ([]bool, error)
	DoTwo(ctx context.Context, arg1 bool) (string, error)
}

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

func FromRobot

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

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

func NewClientFromConn

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

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