retriever

Documentation

Index

• type InitializableRetriever
• type Manager
  • func NewManager(ctx context.Context, retrievers []Retriever, logger *log.Logger) *Manager
  • func (m *Manager) GetRetrievers() []Retriever
  • func (m *Manager) Init(ctx context.Context) error
  • func (m *Manager) Shutdown(ctx context.Context) error
• type Retriever
• type Status

Types

type InitializableRetriever

type InitializableRetriever interface {
	Retrieve(ctx context.Context) ([]byte, error)
	Init(ctx context.Context, logger *log.Logger) error
	Shutdown(ctx context.Context) error
	Status() Status
}

InitializableRetriever is an extended version of the retriever that can be initialized and shutdown.

type Manager

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

Manager is a struct that managed the retrievers.

func NewManager

func NewManager(ctx context.Context, retrievers []Retriever, logger *log.Logger) *Manager

NewManager create a new Manager.

func (*Manager) GetRetrievers

func (m *Manager) GetRetrievers() []Retriever

GetRetrievers return the retrievers. If an error occurred during the initialization of the retrievers, we will return the retrievers that are ready.

func (*Manager) Init

func (m *Manager) Init(ctx context.Context) error

Init the retrievers. This function will call the Init function of the retrievers that implements the InitializableRetriever interface.

func (*Manager) Shutdown

func (m *Manager) Shutdown(ctx context.Context) error

Shutdown the retrievers. This function will call the Shutdown function of the retrievers that implements the InitializableRetriever interface.

type Retriever

type Retriever interface {
	// Retrieve function is supposed to load the file and to return a []byte of your flag configuration file.
	Retrieve(ctx context.Context) ([]byte, error)
}

Retriever is the interface to create a Retriever to load you flags.

type Status

type Status = string

Status is the status of the retriever. It can be used to check if the retriever is ready to be used. If not ready, we wi will not use it.

const (
	RetrieverReady    Status = "READY"
	RetrieverNotReady Status = "NOT_READY"
	RetrieverError    Status = "ERROR"
)