rpcsrv

Documentation

Overview

Package rpcsrv contains utilities for serving mesh databases over RPC.

Index

• Variables
• func Serve(ctx context.Context, db storage.Provider, cli QueryClient) error
• func ServeQuery(ctx context.Context, db storage.Provider, req *v1.QueryRequest) *v1.QueryResponse
• type QueryClient

Variables

var (
	// ErrInvalidQuery is returned when a query is invalid.
	ErrInvalidQuery = fmt.Errorf("invalid query")
	// ErrInvalidArgument is returned when an argument is invalid.
	ErrInvalidArgument = fmt.Errorf("invalid argument")
)

Functions

func Serve

func Serve(ctx context.Context, db storage.Provider, cli QueryClient) error

Serve serves database operations over a plugin query stream.

func ServeQuery

func ServeQuery(ctx context.Context, db storage.Provider, req *v1.QueryRequest) *v1.QueryResponse

ServeQuery serves a storage query given a database and a query request.

Types

type QueryClient

type QueryClient interface {
	// The underlying gRPC stream.
	grpc.ClientStream
	// Send sends a query result to the plugin.
	Send(*v1.QueryResponse) error
	// Recv receives a query request from the plugin.
	Recv() (*v1.QueryRequest, error)
}

QueryClient is the interface for a storage query client.