grpc

Documentation

Overview

Package grpc provides gRPC utility functions, complementing the more common ones in the github.com/grpc/grpc-go package

Index

• func NewGRPCClientConn(opts *Options) (*grpc.ClientConn, error)
• type Options

Functions

func NewGRPCClientConn

func NewGRPCClientConn(opts *Options) (*grpc.ClientConn, error)

NewGRPCClientConn returns a new gRPC pomerium service client connection.

Types

type Options

type Options struct {
	// Addr is the location of the service.  e.g. "service.corp.example:8443"
	Addr *url.URL
	// OverrideCertificateName overrides the server name used to verify the hostname on the
	// returned certificates from the server. gRPC internals also use it to override the virtual
	// hosting name if it is set.
	OverrideCertificateName string
	// CA specifies the base64 encoded TLS certificate authority to use.
	CA string
	// CAFile specifies the TLS certificate authority file to use.
	CAFile string
	// RequestTimeout specifies the timeout for individual RPC calls
	RequestTimeout time.Duration
	// ClientDNSRoundRobin enables or disables DNS resolver based load balancing
	ClientDNSRoundRobin bool

	// WithInsecure disables transport security for this ClientConn.
	// Note that transport security is required unless WithInsecure is set.
	WithInsecure bool

	// ServiceName specifies the service name for telemetry exposition
	ServiceName string
}

Options contains options for connecting to a pomerium rpc service.