Interface StreamingCredentialsProvider

auth/auth.go:8–26

StreamingCredentialsProvider is an interface that defines the methods for a streaming credentials provider. It is used to provide credentials for authentication. The CredentialsListener is used to receive updates when the credentials change.

// It is used to provide credentials for authentication.
// The CredentialsListener is used to receive updates when the credentials change.
type StreamingCredentialsProvider interface {
	// Subscribe subscribes to the credentials provider for updates.
	// It returns the current credentials, a cancel function to unsubscribe from the provider,
	// and an error if any.
	//
	// Implementations MUST be idempotent with respect to listener identity:
	// subscribing the same listener value more than once must not produce
	// duplicate notifications and must not create multiple independent
	// subscriptions that each need to be cancelled separately. Every
	// UnsubscribeFunc returned for a given listener must cancel that
	// listener's subscription; calling any one of them must be sufficient to
	// stop updates to that listener, and calling subsequent ones must be a
	// safe no-op. Callers (including go-redis internals) may retain only
	// the most recently returned UnsubscribeFunc and rely on it to fully
	// unsubscribe the listener.
	//
	// TODO(ndyakov): Should we add context to the Subscribe method?
	Subscribe(listener CredentialsListener) (Credentials, UnsubscribeFunc, error)
}

// UnsubscribeFunc is a function that is used to cancel the subscription to the credentials provider.
// It is used to unsubscribe from the provider when the credentials are no longer needed.