ttgc

Documentation

Overview

Package ttgc implements configuration and a client for The Things Gateway Controller.

Index

• type Client
  • func NewClient(ctx context.Context, c Component, config Config, dialOpts ...grpc.DialOption) (*Client, error)
  • func (c *Client) Domain(context.Context) string
• type Component
• type Config

Types

type Client

type Client struct {
	*grpc.ClientConn
	// contains filtered or unexported fields
}

Client is a client for The Things Gateway Controller.

func NewClient

func NewClient(
	ctx context.Context,
	c Component,
	config Config,
	dialOpts ...grpc.DialOption,
) (*Client, error)

NewClient returns a new client for The Things Gateway Controller.

func (*Client) Domain

func (c *Client) Domain(context.Context) string

Domain returns the domain of the client.

type Component

type Component interface {
	GetTLSClientConfig(context.Context, ...tlsconfig.Option) (*tls.Config, error)
}

Component is the component interface required for this package.

type Config

type Config struct {
	Enabled     bool                 `name:"enabled" description:"Enable The Things Gateway Controller"`
	GatewayEUIs []types.EUI64Prefix  `name:"gateway-euis" description:"Gateway EUI prefixes that are managed by The Things Gateway Controller"` //nolint:lll
	Address     string               `name:"address" description:"The address of The Things Gateway Controller"`
	Domain      string               `name:"domain" description:"The domain of this cluster"`
	TLS         tlsconfig.ClientAuth `name:"tls" description:"TLS configuration"`
}

Config is the configuration for The Things Gateway Controller.