status

Documentation

Overview

Package status implements utility routines related to the status of the Gateway API resource.

Index

• type Mutator
• type MutatorFunc
  • func (m MutatorFunc) Mutate(old client.Object) client.Object
• type RouteStatusProcessor
  • func (p *RouteStatusProcessor) ProcessRouteStatus(_ context.Context, route client.Object) ([]gwv1.RouteParentStatus, error)
• type Update
• type UpdateHandler
  • func NewUpdateHandler(log zerolog.Logger, client client.Client) *UpdateHandler
  • func (u *UpdateHandler) NeedLeaderElection() bool
  • func (u *UpdateHandler) Start(ctx context.Context) error
  • func (u *UpdateHandler) Writer() Updater
• type UpdateWriter
  • func (u *UpdateWriter) Send(update Update)
• type Updater

Types

type Mutator

type Mutator interface {
	Mutate(obj client.Object) client.Object
}

Mutator is an interface to hold mutator functions for status updates.

type MutatorFunc

type MutatorFunc func(client.Object) client.Object

MutatorFunc is a function adaptor for Mutators.

func (MutatorFunc) Mutate

func (m MutatorFunc) Mutate(old client.Object) client.Object

Mutate adapts the MutatorFunc to fit through the Mutator interface.

type RouteStatusProcessor

type RouteStatusProcessor struct {
	Informers *informers.InformerCollection
}

RouteStatusProcessor is responsible for computing the status of a Route

func (*RouteStatusProcessor) ProcessRouteStatus

func (p *RouteStatusProcessor) ProcessRouteStatus(_ context.Context, route client.Object) ([]gwv1.RouteParentStatus, error)

ProcessRouteStatus computes the status of a Route

type Update

type Update struct {
	NamespacedName types.NamespacedName
	Resource       client.Object
	Mutator        Mutator
}

Update contains an all the information needed to update an object's status. Send down a channel to the goroutine that actually writes the changes back.

type UpdateHandler

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

UpdateHandler holds the details required to actually write an Update back to the referenced object.

func NewUpdateHandler

func NewUpdateHandler(log zerolog.Logger, client client.Client) *UpdateHandler

func (*UpdateHandler) NeedLeaderElection

func (u *UpdateHandler) NeedLeaderElection() bool

func (*UpdateHandler) Start

func (u *UpdateHandler) Start(ctx context.Context) error

Start runs the goroutine to perform status writes.

func (*UpdateHandler) Writer

func (u *UpdateHandler) Writer() Updater

Writer retrieves the interface that should be used to write to the UpdateHandler.

type UpdateWriter

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

UpdateWriter takes status updates and sends these to the UpdateHandler via a channel.

func (*UpdateWriter) Send

func (u *UpdateWriter) Send(update Update)

Send sends the given Update off to the update channel for writing by the UpdateHandler.

type Updater

type Updater interface {
	Send(u Update)
}

Updater describes an interface to send status updates somewhere.