client

Documentation

Overview

Package client provides the matchbox gRPC client.

Create a matchbox gRPC client using `client.New`:

cfg := &client.Config{
  Endpoints: []string{"127.0.0.1:8081"},
  DialTimeout: 10 * time.Second,
}
client, err := client.New(cfg)
defer client.Close()

Callers must Close the client after use.

Index

• type Client
  • func New(config *Config) (*Client, error)
  • func (c *Client) Close() error
• type Config

Types

type Client

type Client struct {
	Groups   rpcpb.GroupsClient
	Profiles rpcpb.ProfilesClient
	Ignition rpcpb.IgnitionClient
	Generic  rpcpb.GenericClient
	Select   rpcpb.SelectClient
	// contains filtered or unexported fields
}

Client provides a matchbox client RPC session.

func New

func New(config *Config) (*Client, error)

New creates a new Client from the given Config.

func (*Client) Close

func (c *Client) Close() error

Close closes the client's connections.

type Config

type Config struct {
	// List of endpoint URLs
	Endpoints []string
	// DialTimeout is the timeout for dialing a client connection
	DialTimeout time.Duration
	// Client TLS credentials
	TLS *tls.Config
}

Config configures a Client.