Clarify docs of TargetProvider

This commit is contained in:
Fabian Reinartz 2015-08-13 20:38:25 +02:00
parent b964da4b75
commit 625374ee36

View file

@ -33,7 +33,10 @@ import (
// //
// The TargetProvider does not have to guarantee that an actual change happened. // The TargetProvider does not have to guarantee that an actual change happened.
// It does guarantee that it sends the new TargetGroup whenever a change happens. // It does guarantee that it sends the new TargetGroup whenever a change happens.
// On startup it sends all TargetGroups it can see. //
// Sources() is guaranteed to be called exactly once before each call to Run().
// On a call to Run() implementing types must send a valid target group for each of
// the sources they declared in the last call to Sources().
type TargetProvider interface { type TargetProvider interface {
// Sources returns the source identifiers the provider is currently aware of. // Sources returns the source identifiers the provider is currently aware of.
Sources() []string Sources() []string