discovery

Documentation

Index

• Variables
• type Config
  • func NewConfig() Config
  • func (m Config) GetBool(key string) (*bool, error)
  • func (m Config) GetInt(key string) (int, error)
  • func (m Config) GetMapString(key string) (map[string]string, error)
  • func (m Config) GetString(key string) (string, error)
• type Provider
• type ServiceDiscovery
  • func NewServiceDiscovery(provider Provider, config Config) *ServiceDiscovery
  • func (s ServiceDiscovery) Config() Config
  • func (s ServiceDiscovery) Provider() Provider

Variables

var (
	// ErrAlreadyInitialized is used when attempting to re-initialize the discovery provider
	ErrAlreadyInitialized = errors.New("provider already initialized")
	// ErrNotInitialized is used when the provider is not initialized
	ErrNotInitialized = errors.New("provider not initialized")
	// ErrAlreadyRegistered is used when attempting to re-register the provider
	ErrAlreadyRegistered = errors.New("provider already registered")
)

Types

type Config

type Config map[string]any

Config represents the meta information to pass to the discovery engine

func NewConfig

func NewConfig() Config

NewConfig initializes meta

func (Config) GetBool

func (m Config) GetBool(key string) (*bool, error)

GetBool returns the int value of a given key which value is a boolean If the key value is not a boolean then an error is return

func (Config) GetInt

func (m Config) GetInt(key string) (int, error)

GetInt returns the int value of a given key which value is an integer If the key value is not an integer then an error is return

func (Config) GetMapString

func (m Config) GetMapString(key string) (map[string]string, error)

GetMapString returns the map of string value of a given key which value is a map of string Map of string means that the map key value pair are both string

func (Config) GetString

func (m Config) GetString(key string) (string, error)

GetString returns the string value of a given key which value is a string If the key value is not a string then an error is return

type Provider

type Provider interface {
	// ID returns the discovery name
	ID() string
	// Initialize initializes the plugin: registers some internal data structures, clients etc.
	Initialize() error
	// Register registers this node to a service discovery directory.
	Register() error
	// Deregister removes this node from a service discovery directory.
	Deregister() error
	// SetConfig registers the underlying discovery options
	SetConfig(config Config) error
	// DiscoverPeers returns a list of known nodes.
	DiscoverPeers() ([]string, error)
}

Provider helps discover other running actor system in a cloud environment

type ServiceDiscovery

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

ServiceDiscovery defines the cluster service discovery

func NewServiceDiscovery

func NewServiceDiscovery(provider Provider, config Config) *ServiceDiscovery

NewServiceDiscovery creates an instance of ServiceDiscovery

func (ServiceDiscovery) Config

func (s ServiceDiscovery) Config() Config

Config returns the service discovery config

func (ServiceDiscovery) Provider

func (s ServiceDiscovery) Provider() Provider

Provider returns the service discovery provider