event

Documentation

Index

• type ConfigConf
• type Event
• type EventAck
  • func NewEventAck(gen int) *EventAck
  • func (e *EventAck) GetType() EventType
  • func (e *EventAck) String() string
• type EventFinalize
  • func NewEventFinalize(gen int) *EventFinalize
  • func (e *EventFinalize) GetType() EventType
  • func (e *EventFinalize) String() string
• type EventReconcile
  • func NewEventReconcile() *EventReconcile
  • func (e *EventReconcile) GetType() EventType
  • func (e *EventReconcile) String() string
• type EventRender
  • func NewEventRender(gen int) *EventRender
  • func (e *EventRender) GetType() EventType
  • func (e *EventRender) String() string
• type EventType
  • func NewEventType(raw string) (EventType, error)
  • func (a EventType) String() string
• type EventUpdate
  • func NewEventUpdate(generation int) *EventUpdate
  • func (e *EventUpdate) DeepCopy() *EventUpdate
  • func (e *EventUpdate) GetRequestAck() bool
  • func (e *EventUpdate) GetType() EventType
  • func (e *EventUpdate) SetRequestAck(b bool)
  • func (e *EventUpdate) String() string
• type UpdateConf

Types

type ConfigConf

type ConfigConf = []*stnrv1.StunnerConfig

render event

type Event

type Event interface {
	GetType() EventType
	String() string
}

Event defines an event sent to/from the operator

type EventAck

type EventAck struct {
	Type       EventType
	Generation int
}

EventAck is used by the updater to acknowledge that the update has finished.

func NewEventAck

func NewEventAck(gen int) *EventAck

NewEventAcknowledgement returns an empty event.

func (*EventAck) GetType

func (e *EventAck) GetType() EventType

func (*EventAck) String

func (e *EventAck) String() string

type EventFinalize

type EventFinalize struct {
	Type       EventType
	Generation int
}

EventFinalize is an event that requests the renderer to invalidate managed resources.

func NewEventFinalize

func NewEventFinalize(gen int) *EventFinalize

NewEvent returns an empty event

func (*EventFinalize) GetType

func (e *EventFinalize) GetType() EventType

func (*EventFinalize) String

func (e *EventFinalize) String() string

type EventReconcile

type EventReconcile struct {
	Type EventType
}

reconcile event

func NewEventReconcile

func NewEventReconcile() *EventReconcile

NewEvent returns an empty event

func (*EventReconcile) GetType

func (e *EventReconcile) GetType() EventType

func (*EventReconcile) String

func (e *EventReconcile) String() string

type EventRender

type EventRender struct {
	Type       EventType
	Generation int
}

render event

func NewEventRender

func NewEventRender(gen int) *EventRender

NewEvent returns an empty event

func (*EventRender) GetType

func (e *EventRender) GetType() EventType

func (*EventRender) String

func (e *EventRender) String() string

type EventType

type EventType int

EventType specifies the type of an event sent by the threads of the operator.

const (
	EventTypeUnknown EventType = iota + 1
	// EventTypeRender is sent by the operator to the renderer to request rendering.
	EventTypeRender
	// EventTypeReconcile is sent by the controllers to the operator to trigger reconciliation.
	EventTypeReconcile
	// EventTypeUpdate is created by the renderer thread holding a set of Kubernetes resources
	// that must be crater, updated or deleted. The event is sent from the renderer to the
	// operator, which passes the event on the updater thread for processing.
	EventTypeUpdate
	// EventTypeFinalize is sent from the operator to the renderer to commence the finalization
	// cycle.
	EventTypeFinalize
	// EventTypeFinalize is used by the updater to acknowledge that it has finished processing
	// an update generation.
	EventTypeAck
)

func NewEventType

func NewEventType(raw string) (EventType, error)

NewEventType parses an event type specification

func (EventType) String

func (a EventType) String() string

String returns a string representation for an event

type EventUpdate

type EventUpdate struct {
	Type        EventType
	UpsertQueue UpdateConf
	DeleteQueue UpdateConf
	ConfigQueue ConfigConf
	Generation  int
	RequestAck  bool
}

func NewEventUpdate

func NewEventUpdate(generation int) *EventUpdate

NewEvent returns an empty event

func (*EventUpdate) DeepCopy

func (e *EventUpdate) DeepCopy() *EventUpdate

DeepCopy copies all updated resources into a new update event. This is required to elide locking across the renderer thread and the updater thread.

func (*EventUpdate) GetRequestAck

func (e *EventUpdate) GetRequestAck() bool

GetRequestAck returns true of the event contains an acknowledgement request.

func (*EventUpdate) GetType

func (e *EventUpdate) GetType() EventType

func (*EventUpdate) SetRequestAck

func (e *EventUpdate) SetRequestAck(b bool)

RequestAck asks the updater to send an acknowledgement.

func (*EventUpdate) String

func (e *EventUpdate) String() string

type UpdateConf

type UpdateConf struct {
	GatewayClasses *store.GatewayClassStore
	Gateways       *store.GatewayStore
	UDPRoutes      *store.UDPRouteStore
	UDPRoutesV1A2  *store.UDPRouteStore
	Services       *store.ServiceStore
	ConfigMaps     *store.ConfigMapStore
	Deployments    *store.DeploymentStore
}