grpcutils

Documentation

Index

• func WithResetConnectionBackoffStream() grpc.StreamClientInterceptor
• func WithResetConnectionBackoffUnary() grpc.UnaryClientInterceptor
• type DialOpts
  • func (o DialOpts) Dial(ctx context.Context) (*grpc.ClientConn, error)

Functions

func WithResetConnectionBackoffStream

func WithResetConnectionBackoffStream() grpc.StreamClientInterceptor

WithResetConnectionBackoffStream creates a Stream Interceptor which resets the underlying connection's retry backoff timer. This allows grpc connections to quickly attempt to reconnect to a server e.g. after a server restart.

func WithResetConnectionBackoffUnary

func WithResetConnectionBackoffUnary() grpc.UnaryClientInterceptor

WithResetConnectionBackoffUnary creates a Unary Interceptor which resets the underlying connection's retry backoff timer. This allows grpc connections to quickly attempt to reconnect to a server e.g. after a server restart.

Types

type DialOpts

type DialOpts struct {
	// address of the gRPC server
	Address string

	// connect over plaintext or HTTPS
	Insecure bool

	// Enable fast reconnection attempts on network failures (gRPC code 14 'unavailable')
	ReconnectOnNetworkFailures bool

	// Set this as the authority (host header) on the outbound dial request
	Authority string

	// additional options the caller wishes to inject
	ExtraOptions []grpc.DialOption

	// duration to wait for a connection to be established. if zero, defaults to 1 minute
	Timeout time.Duration
}

DialOpts provides a common set of options for initiating connections to a gRPC server.

func (DialOpts) Dial

func (o DialOpts) Dial(ctx context.Context) (*grpc.ClientConn, error)