configclient

Documentation

Index

• Variables
• func GetConfigurationKey(r configapi.RequestedConfigurationKey) string
• func GetConfigurationKeyFromCfg(c configapi.Configuration) string
• func GetConfigurationSync()
• func Must[T any](val T, err error) T
• func MustDefault[T any](dv T) defaultVal[T]
• type Client
  • func NewClient(serverList []string, opt ClientOptions) *Client
  • func (c *Client) AddConfigurationRequirement(req RequiredConfig)
  • func (c *Client) StartClient() error
  • func (c *Client) StopClient() error
  • func (c *Client) WaitStartupConfigureLoaded(ctx context.Context) error
• type ClientAdv
  • func NewClientAdv(c *Client) *ClientAdv
  • func (c *ClientAdv) Register(group, key string, unmarshaler Unmarshaler, container any) (*atomic.Value, error)
  • func (c *ClientAdv) RegisterJsonContainer(group, key string, container any) (*atomic.Value, error)
• type ClientOptions
  • func (c *ClientOptions) ToOptSelectors() configapi.Selectors
  • func (c *ClientOptions) ToSelectors() configapi.Selectors
• type ConfigContainer
  • func (cc *ConfigContainer[T]) Get() T
  • func (cc *ConfigContainer[T]) Register(c *ClientAdv, group, key string, unmarshaler Unmarshaler) error
  • func (cc *ConfigContainer[T]) RegisterJsonContainer(c *ClientAdv, group, key string) error
• type EnvClient
  • func NewEnvClient() *EnvClient
  • func (c *EnvClient) CaseInsensitive() *EnvClient
  • func (c *EnvClient) GetBool(key string) (bool, error)
  • func (c *EnvClient) GetFloat(key string) (float64, error)
  • func (c *EnvClient) GetInt(key string) (int, error)
  • func (c *EnvClient) GetInt64(key string) (int64, error)
  • func (c *EnvClient) GetString(key string) (string, error)
  • func (e *EnvClient) ParserWarning() error
• type RequiredConfig
• type Unmarshaler

Variables

var (
	ErrNoSuchEnvironmentVariable                = errors.New("no such environment variable")
	ErrHasDuplicatedKeysWithDifferentCaseFormat = errors.New("duplicated keys with different case format")
)

var (
	ErrWaitStartupLoadedTimeout = errors.New("wait startup loaded timeout")
)

Functions

func GetConfigurationKey

func GetConfigurationKey(r configapi.RequestedConfigurationKey) string

func GetConfigurationKeyFromCfg

func GetConfigurationKeyFromCfg(c configapi.Configuration) string

func GetConfigurationSync

func GetConfigurationSync()

func Must

func Must[T any](val T, err error) T

func MustDefault

func MustDefault[T any](dv T) defaultVal[T]

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(serverList []string, opt ClientOptions) *Client

func (*Client) AddConfigurationRequirement

func (c *Client) AddConfigurationRequirement(req RequiredConfig)

func (*Client) StartClient

func (c *Client) StartClient() error

func (*Client) StopClient

func (c *Client) StopClient() error

func (*Client) WaitStartupConfigureLoaded

func (c *Client) WaitStartupConfigureLoaded(ctx context.Context) error

type ClientAdv

type ClientAdv struct {
	// contains filtered or unexported fields
}

func NewClientAdv

func NewClientAdv(c *Client) *ClientAdv

func (*ClientAdv) Register

func (c *ClientAdv) Register(group, key string, unmarshaler Unmarshaler, container any) (*atomic.Value, error)

Register will register auto updated configure container with the same type as the container provided Note that any further update has to be accessed via responded container rather than the container provided in the parameter

func (*ClientAdv) RegisterJsonContainer

func (c *ClientAdv) RegisterJsonContainer(group, key string, container any) (*atomic.Value, error)

RegisterJsonContainer will register auto updated configure container with json configure support Note: the behavior is the same as Register method

type ClientOptions

type ClientOptions struct {
	SelectorEnvironment string
	SelectorDatacenter  string
	SelectorNamespace   string
	SelectorApp         string
	SelectorCluster     string

	SelectorHostName string
	SelectorBeta     string

	OverrideSelectors         *configapi.Selectors // used for overriding detail selector config
	OverrideOptionalSelectors *configapi.Selectors // used for overriding detail selector config

	Auth string

	LocalFallbackDataPath             string
	AllowedLocalFallbackDataTTL       int64 // In seconds. Compare to last retrieved time rather than configuration timestamp.
	AcquireFullConfigurationsInterval int64 // Effective > 0 (in seconds). Used for 1. refresh data, 2. keep fallback data fresh
}

func (*ClientOptions) ToOptSelectors

func (c *ClientOptions) ToOptSelectors() configapi.Selectors

func (*ClientOptions) ToSelectors

func (c *ClientOptions) ToSelectors() configapi.Selectors

type ConfigContainer

type ConfigContainer[T any] struct {

	// OnChange is called when any update on the configuration
	OnChange func(cfg configapi.Configuration, container T)
	// contains filtered or unexported fields
}

ConfigContainer contains the configuration retrieved from the server with auto refresh support

func (*ConfigContainer[T]) Get

func (cc *ConfigContainer[T]) Get() T

func (*ConfigContainer[T]) Register

func (cc *ConfigContainer[T]) Register(c *ClientAdv, group, key string, unmarshaler Unmarshaler) error

Register will register auto updated configure container with the same type as the container provided Note that any further update has to be accessed via responded container rather than the container provided in the parameter

func (*ConfigContainer[T]) RegisterJsonContainer

func (cc *ConfigContainer[T]) RegisterJsonContainer(c *ClientAdv, group, key string) error

RegisterJsonContainer will register auto updated configure container with json configure support Note: the behavior is the same as Register method

type EnvClient

type EnvClient struct {
	// contains filtered or unexported fields
}

func NewEnvClient

func NewEnvClient() *EnvClient

func (*EnvClient) CaseInsensitive

func (c *EnvClient) CaseInsensitive() *EnvClient

func (*EnvClient) GetBool

func (c *EnvClient) GetBool(key string) (bool, error)

func (*EnvClient) GetFloat

func (c *EnvClient) GetFloat(key string) (float64, error)

func (*EnvClient) GetInt

func (c *EnvClient) GetInt(key string) (int, error)

func (*EnvClient) GetInt64

func (c *EnvClient) GetInt64(key string) (int64, error)

func (*EnvClient) GetString

func (c *EnvClient) GetString(key string) (string, error)

func (*EnvClient) ParserWarning

func (e *EnvClient) ParserWarning() error

type RequiredConfig

type RequiredConfig struct {
	Required configapi.RequestedConfigurationKey
	Callback func(cfg configapi.Configuration)
}

type Unmarshaler

type Unmarshaler func([]byte, interface{}) error