hub

Documentation

Overview

Package hub exposes sup actors, controls, signals, and events over HTTP.

Index

• type Hub
  • func New(id string, options ...Option) *Hub
  • func (h *Hub) Handler() http.Handler
  • func (h *Hub) Inspect() sup.Spec
  • func (h *Hub) Observer() *sup.SupervisorObserver
  • func (h *Hub) RegisterActor(actor sup.Actor)
  • func (h *Hub) Run(ctx context.Context) error
• type Option
  • func WithActor(actor sup.Actor) Option
  • func WithEventLimit(limit int) Option
  • func WithSignal[V any](signal sup.ReadableSignal[V]) Option

Types

type Hub

type Hub struct {
	*sup.BaseActor
	// contains filtered or unexported fields
}

Hub exposes actors, controls, signals, and events over HTTP.

func New

func New(id string, options ...Option) *Hub

New creates a hub with the given id and options.

func (*Hub) Handler

func (h *Hub) Handler() http.Handler

Handler returns the HTTP handler for the hub API and debug UI.

func (*Hub) Inspect

func (h *Hub) Inspect() sup.Spec

Inspect returns the hub spec.

func (*Hub) Observer

func (h *Hub) Observer() *sup.SupervisorObserver

Observer returns a supervisor observer that records actor lifecycle events.

func (*Hub) RegisterActor

func (h *Hub) RegisterActor(actor sup.Actor)

RegisterActor registers an actor with the hub.

func (*Hub) Run

func (h *Hub) Run(ctx context.Context) error

Run starts registered signal streams until they stop, fail, or the context is canceled.

type Option

type Option func(*Hub)

Option configures a Hub.

func WithActor

func WithActor(actor sup.Actor) Option

WithActor registers an actor with the hub.

func WithEventLimit

func WithEventLimit(limit int) Option

WithEventLimit sets the maximum number of events stored per source.

func WithSignal

func WithSignal[V any](signal sup.ReadableSignal[V]) Option

WithSignal registers a readable signal with the hub.