Documentation
¶
Overview ¶
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 ¶
const Version = "2.0.3"
Version specifies the gax-go version being used.
Variables ¶
This section is empty.
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 ¶
Sleep is similar to time.Sleep, but it can be interrupted by ctx.Done() closing. If interrupted, Sleep returns ctx.Err().
func XGoogHeader ¶
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 func(context.Context, CallSettings) error
APICall is a user defined call stub.
type Backoff ¶
type Backoff struct {
// Initial is the initial value of the retry envelope, defaults to 1 second.
Initial time.Duration
// Max is the maximum value of the retry envelope, defaults to 30 seconds.
Max time.Duration
// Multiplier is the factor by which the retry envelope increases.
// It should be greater than 1 and defaults to 2.
Multiplier float64
// contains filtered or unexported fields
}
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 interface {
// Resolve applies the option by modifying cs.
Resolve(cs *CallSettings)
}
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
WithGRPCOptions allows passing gRPC call options during client creation.
func WithRetry ¶
func WithRetry(fn func() Retryer) CallOption
WithRetry sets CallSettings.Retry to fn.
type CallSettings ¶
type CallSettings struct {
// Retry returns a Retryer to be used to control retry logic of a method call.
// If Retry is nil or the returned Retryer is nil, the call will not be retried.
Retry func() Retryer
// CallOptions to be forwarded to GRPC.
GRPC []grpc.CallOption
}
CallSettings allow fine-grained control over how calls are made.
type Retryer ¶
type Retryer interface {
// Retry reports whether a request should be retriedand how long to pause before retrying
// if the previous attempt returned with err. Invoke never calls Retry with nil error.
Retry(err error) (pause time.Duration, shouldRetry bool)
}
Retryer is used by Invoke to determine retry behavior.
Source Files