rpc

README

gRPC API for Horizon

To generate *.pb.go files

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

To generate gRPC documentation

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

Documentation

Index

• func NewMicroserice(matcher *horizon.MapMatcher, reflect bool) (*grpc.Server, error)
• type Microservice
  • func (ts *Microservice) GetIsochrones(ctx context.Context, in *protos_pb.IsochronesRequest) (*protos_pb.IsochronesResponse, error)
  • func (ts *Microservice) GetSP(ctx context.Context, in *protos_pb.SPRequest) (*protos_pb.SPResponse, error)
  • func (ts *Microservice) RunMapMatch(ctx context.Context, in *protos_pb.MapMatchRequest) (*protos_pb.MapMatchResponse, error)

Functions

func NewMicroserice

func NewMicroserice(matcher *horizon.MapMatcher, reflect bool) (*grpc.Server, error)

NewMicroserice creates a new gRPC server instance with the provided matcher and reflection option.

Types

type Microservice

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

Microservice represents a gRPC server that implements the ServiceServer interface and wraps a map matcher engine

func (*Microservice) GetIsochrones

func (ts *Microservice) GetIsochrones(ctx context.Context, in *protos_pb.IsochronesRequest) (*protos_pb.IsochronesResponse, error)

GetIsochrones Implement GetIsochrones() to match interface

func (*Microservice) GetSP

func (ts *Microservice) GetSP(ctx context.Context, in *protos_pb.SPRequest) (*protos_pb.SPResponse, error)

GetSP Implement GetSP() to match interface

func (*Microservice) RunMapMatch

func (ts *Microservice) RunMapMatch(ctx context.Context, in *protos_pb.MapMatchRequest) (*protos_pb.MapMatchResponse, error)

RunMapMatch Implement RunMapMatch() to match interface