pubsub

Documentation

Overview

Package pubsub provides cluster-wide publishing and subscribing of events

Index

• Variables
• func WriteSSEEvent(w io.Writer, data []byte, event EventType, base64encode bool)
• type Broker
  • func NewBroker[T any](logger logr.Logger, listener databaseListener, table string, ...) *Broker[T]
  • func (b *Broker[T]) Subscribe(ctx context.Context) (<-chan Event[T], func())
• type Event
  • func NewCreatedEvent[T any](payload T) Event[T]
  • func NewDeletedEvent[T any](payload T) Event[T]
  • func NewUpdatedEvent[T any](payload T) Event[T]
• type EventType
• type GetterFunc
• type SubscriptionService

Variables

var ErrSubscriptionTerminated = errors.New("broker terminated the subscription")

ErrSubscriptionTerminated is for use by subscribers to indicate that their subscription has been terminated by the broker.

Functions

func WriteSSEEvent

func WriteSSEEvent(w io.Writer, data []byte, event EventType, base64encode bool)

WriteSSEEvent writes an server-side-event to w. The data is optionally base64 encoded before being written.

Types

type Broker

type Broker[T any] struct {
	logr.Logger
	// contains filtered or unexported fields
}

Broker allows clients to subscribe to OTF events.

func NewBroker

func NewBroker[T any](logger logr.Logger, listener databaseListener, table string, kind resource.Kind, getter GetterFunc[T]) *Broker[T]

func (*Broker[T]) Subscribe

func (b *Broker[T]) Subscribe(ctx context.Context) (<-chan Event[T], func())

Subscribe subscribes the caller to a stream of events. The caller can close the subscription by either canceling the context or calling the returned unsubscribe function.

type Event

type Event[T any] struct {
	Type    EventType
	Payload T
}

Event represents an event in the lifecycle of an otf resource

func NewCreatedEvent

func NewCreatedEvent[T any](payload T) Event[T]

func NewDeletedEvent

func NewDeletedEvent[T any](payload T) Event[T]

func NewUpdatedEvent

func NewUpdatedEvent[T any](payload T) Event[T]

type EventType

type EventType string

EventType identifies the type of event

const (
	EventError       EventType = "error"
	EventInfo        EventType = "info"
	EventLogChunk    EventType = "log_update"
	EventLogFinished EventType = "log_finished"
	EventVCS         EventType = "vcs_event"

	CreatedEvent EventType = "created"
	UpdatedEvent EventType = "updated"
	DeletedEvent EventType = "deleted"
)

type GetterFunc

type GetterFunc[T any] func(ctx context.Context, id resource.ID, action sql.Action) (T, error)

GetterFunc retrieves the type T using its unique id.

type SubscriptionService

type SubscriptionService[T any] interface {
	Subscribe(context.Context) (<-chan Event[T], func())
}

SubscriptionService is a service that provides subscriptions to events