Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CommonInitializableRetriever ¶ added in v1.30.0
type CommonInitializableRetriever interface { Retriever Shutdown(ctx context.Context) error Status() Status }
CommonInitializableRetriever is the common interface for all versions of retrievers that can be initialized and shutdown.
type InitializableRetriever ¶ added in v1.21.0
type InitializableRetriever interface { CommonInitializableRetriever Init(ctx context.Context, logger *fflog.FFLogger) error }
InitializableRetriever is an extended version of the retriever that can be initialized and shutdown.
type InitializableRetrieverLegacy ¶ added in v1.30.0
type InitializableRetrieverLegacy interface { CommonInitializableRetriever Init(ctx context.Context, logger *log.Logger) error }
InitializableRetrieverLegacy is an extended version of the retriever that can be initialized and shutdown.
type Manager ¶ added in v1.21.0
type Manager struct {
// contains filtered or unexported fields
}
Manager is a struct that managed the retrievers.
func NewManager ¶ added in v1.21.0
NewManager create a new Manager.
func (*Manager) GetRetrievers ¶ added in v1.21.0
GetRetrievers return the retrievers. If an error occurred during the initialization of the retrievers, we will return the retrievers that are ready.
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 ¶ added in v1.21.0
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 is the status when the retriever is ready to be used. RetrieverReady Status = "READY" // RetrieverNotReady is the status when the retriever is not ready yet to be used. RetrieverNotReady Status = "NOT_READY" // RetrieverError is the status when the retriever is in error. RetrieverError Status = "ERROR" )