Documentation
¶
Overview ¶
Package config provides configuration structures and client factories for plugins.
Index ¶
- type ClientFactories
- type DefaultClientFactories
- func (c *DefaultClientFactories) Close() error
- func (c *DefaultClientFactories) GRPCClientConn(url string, dialOpts ...grpc.DialOption) (grpc.ClientConnInterface, error)
- func (c *DefaultClientFactories) GoogleHTTPClient(ctx context.Context, scope ...string) (*http.Client, error)
- func (c *DefaultClientFactories) HTTPClient() *http.Client
- type PluginConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ClientFactories ¶
type ClientFactories interface {
HTTPClient() *http.Client
GRPCClientConn(url string, dialOpts ...grpc.DialOption) (grpc.ClientConnInterface, error)
GoogleHTTPClient(ctx context.Context, scope ...string) (*http.Client, error)
}
ClientFactories defines methods to obtain shared clients and connections.
type DefaultClientFactories ¶
type DefaultClientFactories struct {
// contains filtered or unexported fields
}
DefaultClientFactories provides a default implementation of ClientFactories.
func NewDefaultClientFactories ¶
func NewDefaultClientFactories(userAgent string) *DefaultClientFactories
NewDefaultClientFactories returns a new DefaultClientFactories.
func (*DefaultClientFactories) Close ¶
func (c *DefaultClientFactories) Close() error
Close closes all managed gRPC connections and idle HTTP connections.
func (*DefaultClientFactories) GRPCClientConn ¶
func (c *DefaultClientFactories) GRPCClientConn(url string, dialOpts ...grpc.DialOption) (grpc.ClientConnInterface, error)
GRPCClientConn returns a shared gRPC connection.
func (*DefaultClientFactories) GoogleHTTPClient ¶
func (c *DefaultClientFactories) GoogleHTTPClient(ctx context.Context, scope ...string) (*http.Client, error)
GoogleHTTPClient returns a shared HTTP client authenticated for Google services.
func (*DefaultClientFactories) HTTPClient ¶
func (c *DefaultClientFactories) HTTPClient() *http.Client
HTTPClient returns a shared HTTP client.
type PluginConfig ¶
type PluginConfig struct {
ProtoConfig *cpb.PluginConfig
ClientFactories ClientFactories
}
PluginConfig wraps the proto generated PluginConfig to allow passing arbitrary pointers/interfaces.
func DefaultPluginConfig ¶
func DefaultPluginConfig() *PluginConfig
DefaultPluginConfig returns a PluginConfig with default client factories.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package configtest provides fake implementations of config.ClientFactories for testing.
|
Package configtest provides fake implementations of config.ClientFactories for testing. |