gob

Documentation

Index

• func DisableRetries(ctx context.Context) context.Context
• func EnableRetries(ctx context.Context) context.Context
• func ErrorIsRetriable(err error) bool
• func Execute(ctx context.Context, opName string, fn func() error) error
• func UseTestClock(ctx context.Context) context.Context

Functions

func DisableRetries

func DisableRetries(ctx context.Context) context.Context

DisableRetries disables retries for Execute.

func EnableRetries

func EnableRetries(ctx context.Context) context.Context

EnableRetries enables retries for Execute (the default behavior).

func ErrorIsRetriable

func ErrorIsRetriable(err error) bool

ErrorIsRetriable determines whether an error would be retried by Execute.

func Execute

func Execute(ctx context.Context, opName string, fn func() error) error

Execute attempts a GoB operation with retries.

Execute mitigates the effects of short-lived outages and replication lag by retrying operations with certain error codes. The service client's error should be returned in order to correctly detect this situation. The retries will use exponential backoff with a context with the clock tagged with "gob-retry". When performing retries, a log will be emitted that uses opName to identify the operation that is being retried.

Retries will not be performed in the following cases:

• The provided context is one that has had DisableRetries called on it more recently than EnableRetries
• The error returned from the operation is tagged with DontRetry

func UseTestClock

func UseTestClock(ctx context.Context) context.Context