grpc

Documentation

Index

• Variables
• func StartServer(conf *pb.ServerConfig, server pb.VerifiableDataStructuresServiceServer)
• type Client
  • func (g *Client) Dial() (pb.VerifiableDataStructuresServiceServer, error)
  • func (g *Client) MustDial() pb.VerifiableDataStructuresServiceServer

Variables

var (
	// ErrNoCertsFound is returned when no certificates are found in the specifed file
	ErrNoCertsFound = errors.New("no certificates found")
)

Functions

func StartServer

func StartServer(conf *pb.ServerConfig, server pb.VerifiableDataStructuresServiceServer)

StartServer starts a gRPC server given a service. Normally this service is an instance of LocalService.

Types

type Client

type Client struct {
	// NoGrpcSecurity if set will disable TLS for this connection
	NoGrpcSecurity bool

	// CertDer is an ASN.1 DER X.509 certificate that the certificate presented by the server
	// must be signed by. This can be either a self-signed, or private CA cert.
	// If not set, the system CA pool is used.
	CertDer []byte

	// Address of the server to connect to, e.g. "localhost:8080"
	Address string
}

Client provides a way to access a remote Verifiable Data Structures API using gRPC. This is preferred over the REST server/client.

func (*Client) Dial

func (g *Client) Dial() (pb.VerifiableDataStructuresServiceServer, error)

Dial connects to the server and returns an object to communicate with it. Most users will wrap this with the higher-level API.

func (*Client) MustDial

func (g *Client) MustDial() pb.VerifiableDataStructuresServiceServer

MustDial is a convenience method that exits with a fatal error if the operation fails