status

Documentation

Index

• type Queue
  • func NewQueue() *Queue
  • func (q *Queue) Publish(obj client.Object)
  • func (q *Queue) Subscribe(gvk schema.GroupVersionKind) chan event.GenericEvent

Types

type Queue

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

Queue provides a pub/sub queue with channels for individual Kubernetes objects, the purpose of which is to submit GenericEvents for those objects to trigger reconciliation when the object has been successfully configured in the dataplane so that its status can be updated (for instance, with IP address information in the case of Ingress resources).

func NewQueue

func NewQueue() *Queue

NewQueue provides a new Queue object which can be used to publish status update events or subscribe to those events.

func (*Queue) Publish

func (q *Queue) Publish(obj client.Object)

Publish emits a GenericEvent for the provided objects that indicates to subscribers that the status of that object needs to be updated.

func (*Queue) Subscribe

func (q *Queue) Subscribe(gvk schema.GroupVersionKind) chan event.GenericEvent

Subscribe provides a consumer channel where generic events for the provided object kind will be published when the status for the object needs to be updated.

Note that more than one consumer can subscribe to a channel for a particular object kind, but that this only represents a single channel: events will not be duplicated and each subscriber will receive events on a first come first serve basis.