package gax

import "github.com/googleapis/gax-go"

Package gax contains a set of modules which aid the development of APIs for clients and servers based on gRPC and Google API conventions.

Application code will rarely need to use this library directly. However, code generated automatically from API definition files can use it to simplify code generation and to provide more convenient and idiomatic API surfaces.

Index ¶

• Constants
• func Invoke(ctx context.Context, call APICall, opts ...CallOption) error
• func Sleep(ctx context.Context, d time.Duration) error
• func XGoogHeader(keyval ...string) string
• type APICall
• type Backoff
• type CallOption
• func WithGRPCOptions(opt ...grpc.CallOption) CallOption
• func WithRetry(fn func() Retryer) CallOption
• type CallSettings
• type Retryer
• func OnCodes(cc []codes.Code, bo Backoff) Retryer

Constants ¶

const Version = "1.0.1"

Functions ¶

func Invoke ¶

func Invoke(ctx context.Context, call APICall, opts ...CallOption) error

Invoke calls the given APICall, performing retries as specified by opts, if any.

func Sleep ¶

func Sleep(ctx context.Context, d time.Duration) error

Sleep is similar to time.Sleep, but it can be interrupted by ctx.Done() closing. If interrupted, Sleep returns ctx.Err().

func XGoogHeader ¶

func XGoogHeader(keyval ...string) string

XGoogHeader is for use by the Google Cloud Libraries only.

XGoogHeader formats key-value pairs. The resulting string is suitable for x-goog-api-client header.

Types ¶

type APICall ¶

type APICall = v2.APICall

A user defined call stub.

type Backoff ¶

type Backoff = v2.Backoff

Backoff implements exponential backoff. The wait time between retries is a random value between 0 and the "retry envelope". The envelope starts at Initial and increases by the factor of Multiplier every retry, but is capped at Max.

type CallOption ¶

type CallOption = v2.CallOption

CallOption is an option used by Invoke to control behaviors of RPC calls. CallOption works by modifying relevant fields of CallSettings.

func WithGRPCOptions ¶

func WithGRPCOptions(opt ...grpc.CallOption) CallOption

func WithRetry ¶

func WithRetry(fn func() Retryer) CallOption

WithRetry sets CallSettings.Retry to fn.

type CallSettings ¶

type CallSettings = v2.CallSettings

type Retryer ¶

type Retryer = v2.Retryer

Retryer is used by Invoke to determine retry behavior.

func OnCodes ¶

func OnCodes(cc []codes.Code, bo Backoff) Retryer

OnCodes returns a Retryer that retries if and only if the previous attempt returns a GRPC error whose error code is stored in cc. Pause times between retries are specified by bo.

bo is only used for its parameters; each Retryer has its own copy.

Source Files ¶

call_option.go gax.go header.go invoke.go