rpc

README

Generate *.pb.go files

protoc -I service/rpc/protos service/rpc/protos/*.proto --go_out=service/rpc/protos/ --go-grpc_out=service/rpc/protos/ --go-grpc_opt=paths=source_relative --experimental_allow_proto3_optional

Note: flag experimental_allow_proto3_optional is not required but could be usefull in future works

Generate documentation

mkdir -p ./service/rpc/docs
protoc -I service/rpc/protos service/rpc/protos/*.proto --doc_out=./service/rpc/docs --doc_opt=html,service.html  --experimental_allow_proto3_optional
protoc -I service/rpc/protos service/rpc/protos/*.proto --doc_out=./service/rpc/docs --doc_opt=markdown,service.md  --experimental_allow_proto3_optional

Documentation

Index

• Variables
• func NewMicroserice(engine *license_plate_recognition.LPRQueue) (*grpc.Server, error)
• type Microservice
  • func (ts *Microservice) ProcessImage(ctx context.Context, in *protos.LPRRequest) (*protos.LPRResponse, error)
  • func (microservice *Microservice) SendToQueue(req *license_plate_recognition.QueueRequest) (*license_plate_recognition.QueueResponse, error)

Variables

var (
	ErrBadBoundingBBox = fmt.Errorf("bad bounding box")
	ErrBadDetections   = fmt.Errorf("bad detections")
)

Functions

func NewMicroserice

func NewMicroserice(engine *license_plate_recognition.LPRQueue) (*grpc.Server, error)

Types

type Microservice

type Microservice struct {
	protos.ServiceServer
	// contains filtered or unexported fields
}

func (*Microservice) ProcessImage

func (ts *Microservice) ProcessImage(ctx context.Context, in *protos.LPRRequest) (*protos.LPRResponse, error)

ProcessImage is to match gRPC server interface. Provides business logic for processing image

func (*Microservice) SendToQueue

func (microservice *Microservice) SendToQueue(req *license_plate_recognition.QueueRequest) (*license_plate_recognition.QueueResponse, error)

microservice is just an alias to internal implementation