client

package
Version: v0.9.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 1, 2022 License: Apache-2.0 Imports: 8 Imported by: 1

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

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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.

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL