Add a little bit of documentation to NotifyPods
As far as I can tell, based on the implementation in MockProvider NotifyPods is called with the mutated pod. This allows us to take a copy of the Pod object in NotifyPods, and make it so (eventually) we don't need to do a callback to GetPodStatus.
This commit is contained in:
@@ -69,9 +69,13 @@ type PodLifecycleHandler interface {
|
|||||||
// of pod status updates asynchronously.
|
// of pod status updates asynchronously.
|
||||||
type PodNotifier interface {
|
type PodNotifier interface {
|
||||||
// NotifyPods instructs the notifier to call the passed in function when
|
// NotifyPods instructs the notifier to call the passed in function when
|
||||||
// the pod status changes.
|
// the pod status changes. It should be called when a pod's status changes.
|
||||||
//
|
//
|
||||||
// NotifyPods should not block callers.
|
// The provided pointer to a Pod is guaranteed to be used in a read-only
|
||||||
|
// fashion. The provided pod's PodStatus should be up to date when
|
||||||
|
// this function is called.
|
||||||
|
//
|
||||||
|
// NotifyPods will not block callers.
|
||||||
NotifyPods(context.Context, func(*corev1.Pod))
|
NotifyPods(context.Context, func(*corev1.Pod))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user