grpc

Documentation

Overview

Package grpc provides gRPC client utilities.

Index

• Constants
• func ConnectToEndpoint(ctxopts ...ContextOpts) (*grpc.ClientConn, error)
• func ConnectToEndpointOrExit(ctxopts ...ContextOpts) *grpc.ClientConn
• type ContextOpts

Constants

const (
	// DialTimeout is the default gRPC dial timeout in seconds.
	DialTimeout = 30

	// PingTime is the default gRPC keep-alive ping time internal in seconds. This corresponds to the minimum ping wait
	// time on the server side. Ref.: https://pkg.go.dev/google.golang.org/grpc/keepalive#EnforcementPolicy
	PingTime = 300

	// PingTimeout is the default gRPC keep-alive ping timeout in seconds.
	PingTimeout = 30

	// UnaryTimeout is the default unary RPC timeout in seconds.
	UnaryTimeout = 30
)

Functions

func ConnectToEndpoint

func ConnectToEndpoint(ctxopts ...ContextOpts) (*grpc.ClientConn, error)

ConnectToEndpoint attempts to connect to the provided endpoint. If endpoint is empty, it picks up the endpoint from the current auth ctx.

func ConnectToEndpointOrExit

func ConnectToEndpointOrExit(ctxopts ...ContextOpts) *grpc.ClientConn

ConnectToEndpointOrExit returns a client connection to the provided endpoint. If it encounters an error, it exits.

Types

type ContextOpts

type ContextOpts func(context.Context) context.Context

ContextOpts for the context.