gitiles

Documentation

Index

• func NewRetriableClient(c Client) *retriableClient
• func SetClient(ctx context.Context, client Client) context.Context
• type Client
  • func GetClient(ctx context.Context) Client
  • func NewThrottlingClient(host string, limiter *rate.Limiter) (Client, error)

Functions

func NewRetriableClient

func NewRetriableClient(c Client) *retriableClient

NewRetriableClient creates Gitiles client that automatically retries with exponential backoff if error was insufficient quota.

func SetClient

func SetClient(ctx context.Context, client Client) context.Context

SetClient stores gitilesClient in context. Useful for unit testing.

Types

type Client

type Client interface {
	Log(ctx context.Context, in *gitilesProto.LogRequest, opts ...grpc.CallOption) (out *gitilesProto.LogResponse, err error)
	Refs(ctx context.Context, in *gitilesProto.RefsRequest, opts ...grpc.CallOption) (out *gitilesProto.RefsResponse, err error)
	Archive(ctx context.Context, in *gitilesProto.ArchiveRequest, opts ...grpc.CallOption) (out *gitilesProto.ArchiveResponse, err error)
	DownloadFile(ctx context.Context, in *gitilesProto.DownloadFileRequest, opts ...grpc.CallOption) (out *gitilesProto.DownloadFileResponse, err error)
	Projects(ctx context.Context, in *gitilesProto.ProjectsRequest, opts ...grpc.CallOption) (out *gitilesProto.ProjectsResponse, err error)
}

func GetClient

func GetClient(ctx context.Context) Client

GetClient returns gitilesClient from context. If not set, it panics.

func NewThrottlingClient

func NewThrottlingClient(host string, limiter *rate.Limiter) (Client, error)

NewThrottlingClient creates REST Gitiles client and consumes limiter quota on each API call to Gitiles. If there is no quota left, it blocks until there is.