api

Documentation

Index

• func AddCA(pemBytes []byte) (err error)
• func CloseAll()
• func Dial(ctx context.Context, target string) (*grpc.ClientConn, error)
• func GetCallOptions() (opts []grpc.CallOption)
• func GetDialOptions() (opts []grpc.DialOption)
• func SetAuth(authType, authValue string)
• func SetDumpRequests(dump bool)
• func SetInsecure(insecure bool)
• func SetLogger(logger log.Interface)
• func SetRetryDefaultTimeout(t time.Duration)
• func SetRetryEnableMetadata(b bool)
• func SetRetryJitter(f float64)
• func SetRetryMax(rm uint)

Functions

func AddCA

func AddCA(pemBytes []byte) (err error)

AddCA adds the CA certificate file.

func CloseAll

func CloseAll()

CloseAll closes all remaining gRPC connections.

func Dial

func Dial(ctx context.Context, target string) (*grpc.ClientConn, error)

func GetCallOptions

func GetCallOptions() (opts []grpc.CallOption)

GetCallOptions returns the gRPC call options.

func GetDialOptions

func GetDialOptions() (opts []grpc.DialOption)

GetDialOptions gets the dial options for a gRPC connection.

func SetAuth

func SetAuth(authType, authValue string)

SetAuth sets the authentication information.

func SetDumpRequests

func SetDumpRequests(dump bool)

SetDumpRequests configures the API options to dump gRPC requests.

func SetInsecure

func SetInsecure(insecure bool)

SetInsecure configures the API to use insecure connections.

func SetLogger

func SetLogger(logger log.Interface)

SetLogger sets the default API logger

func SetRetryDefaultTimeout

func SetRetryDefaultTimeout(t time.Duration)

SetRetryDefaultTimeout configures the default timeout before making a retry in a failed request.

func SetRetryEnableMetadata

func SetRetryEnableMetadata(b bool)

SetRetryEnableMetadata configures if the retry procedure will read the request's metadata or not.

func SetRetryJitter

func SetRetryJitter(f float64)

SetRetryJitter configures the fraction to be used in the deviation procedure of the rpcretry timeout.

func SetRetryMax

func SetRetryMax(rm uint)

SetRetryMax configures the amount of time the client will retry the request.