tether

package module

Go to main page

Versions in this module

v0

v0.3.3

May 5, 2026

v0.3.2

Apr 13, 2026

Changes in this version

+ var Runtime runtimeFactory

type App

+ WireFormat wire.Format

type Client

+ Runtime ClientRuntime

+ type ClientRuntime interface

v0.3.1

Apr 10, 2026

v0.3.0

Apr 8, 2026

Changes in this version

+ func SetCluster(c Cluster)

type App

+ Cluster Cluster

type BusConfig

+ Topic string

+ type Cluster interface

+ Publish func(ctx context.Context, topic string, data []byte) error

+ Subscribe func(topic string, fn func(data []byte)) func()

v0.3.0-rc1

Apr 7, 2026

v0.2.3

Apr 3, 2026

v0.2.2

Mar 31, 2026

Changes in this version

type App

+ Fallback func(w http.ResponseWriter, r *http.Request) (Transport, error)

+ MaxPending int

+ MaxSessions int

+ ShutdownGrace time.Duration

+ Upgrade func(w http.ResponseWriter, r *http.Request) (Transport, error)

type CaptureSession

+ MorphKeys []string

+ func (cs *CaptureSession) Morph(keys ...string)

type Group

+ func (g *Group[S]) Each(fn func(target *StatefulSession[S]))

type Session

+ Morph func(keys ...string)

type StatefulSession

+ func (s *StatefulSession[S]) Morph(keys ...string)

v0.2.1

Mar 28, 2026

Changes in this version

type DiagnosticKind

+ const HighMemoiseMissRate

+ const RenderCoalesced

+ const SlowRender

+ const StateSizeExceeded

type Limits

+ MaxNavigateRedirects int

+ MaxStateBytes int64

type StatefulConfig

+ Memoise bool

type StatefulSession

+ func (s *StatefulSession[S]) Patch(key string, fn func(S) (S, node.Node))

type Timeouts

+ MemoiseMissThreshold float64

+ PendingCheck time.Duration

+ SlowRender time.Duration

+ type Versioned struct

+ Val T

+ func NewVersioned[T any](data T) Versioned[T]

+ func (v Versioned[T]) Version() int

+ func (v Versioned[T]) With(data T) Versioned[T]

v0.2.0

Mar 25, 2026

Changes in this version

type Asset

+ WatchDir string

+ func (a *Asset) Close() error

type CaptureSession

+ func (cs *CaptureSession) Download(url string)

+ func (cs *CaptureSession) ScrollTo(selector string)

type Effects

+ Download string

+ ScrollTo string

type Group

+ func (g *Group[S]) Count() *Value[int]

+ type Presence struct

+ func NewPresence[T any]() *Presence[T]

+ func (p *Presence[T]) All() map[string]T

+ func (p *Presence[T]) Clear(sessionID string)

+ func (p *Presence[T]) Each(exclude string, fn func(sessionID string, val T))

+ func (p *Presence[T]) Get(sessionID string) (T, bool)

+ func (p *Presence[T]) Len() int

+ func (p *Presence[T]) Set(sessionID string, val T)

type Session

+ Download func(url string)

+ ScrollTo func(selector string)

type StatefulSession

+ func (s *StatefulSession[S]) Download(url string)

+ func (s *StatefulSession[S]) ScrollTo(selector string)

v0.1.0

Mar 23, 2026

Changes in this version

+ var ErrPushNoSubscription = errors.New("tether: no push subscription for session")

+ var ErrPushNotConfigured = errors.New("tether: push not configured")

+ var ErrPushPreWarm = errors.New("tether: push not available during pre-warming")

+ func Catch(render func() node.Node, fallback node.Node) (result node.Node)

+ func InitMounts[S any](mounts []ComponentMount[S], sess Session, state S) S

+ func ListenAndServe(addr string, handler http.Handler, drainers ...Drainable) error

+ func ListenAndServeTLS(addr, certFile, keyFile string, handler http.Handler, drainers ...Drainable) error

+ func Observe[V any, S any](s *StatefulSession[S], val *Value[V], fn func(V, S) S)

+ func On[E any, S any](s *StatefulSession[S], bus *Bus[E], fn func(E, S) S)

+ func RouteMount[S any](mounts []ComponentMount[S], sess Session, state S, ev Event) (S, bool)

+ func RouteTyped[C Component](comp C, prefix string, sess Session, ev Event) C

+ func ServeClient() http.Handler

+ func Stateless[S any](app App, cfg StatelessConfig[S]) http.Handler

+ type App struct

+ Assets []*Asset

+ Client Client

+ DevMode bool

+ Logger *slog.Logger

+ Security Security

+ type Asset struct

+ FS fs.FS

+ Precache []string

+ Prefix string

+ func (a *Asset) Script(path string) node.Node

+ func (a *Asset) Stylesheet(path string) node.Node

+ func (a *Asset) URL(path string) string

+ type AsyncOverflow int

+ const Block

+ const Drop

+ const Inline

+ type Bus struct

+ func NewBus[E any](cfg ...BusConfig) *Bus[E]

+ func (b *Bus[E]) Emit(s Session, event E)

+ func (b *Bus[E]) Len() int

+ func (b *Bus[E]) Publish(event E)

+ func (b *Bus[E]) Subscribe(ctx context.Context, fn func(E)) func()

+ func (b *Bus[E]) SubscribeAsync(ctx context.Context, fn func(E)) func()

+ type BusConfig struct

+ AsyncOverflow AsyncOverflow

+ AsyncWorkers int

+ type CaptureSession struct

+ Ctx context.Context

+ Effects Effects

+ PushErr error

+ SessionID string

+ func (cs *CaptureSession) Announce(text string)

+ func (cs *CaptureSession) Close()

+ func (cs *CaptureSession) Context() context.Context

+ func (cs *CaptureSession) Flash(selector, text string)

+ func (cs *CaptureSession) Go(fn func(context.Context))

+ func (cs *CaptureSession) ID() string

+ func (cs *CaptureSession) Navigate(rawURL string)

+ func (cs *CaptureSession) Push(push.Notification) error

+ func (cs *CaptureSession) ReplaceURL(rawURL string)

+ func (cs *CaptureSession) SetTitle(title string)

+ func (cs *CaptureSession) Signal(key string, value any)

+ func (cs *CaptureSession) Signals(signals map[string]any)

+ func (cs *CaptureSession) Toast(text string)

+ type Client struct

+ BackgroundSync bool

+ DefaultDebounce time.Duration

+ FlashDuration time.Duration

+ SyncRetention time.Duration

+ ToastDuration time.Duration

+ TransitionTimeout time.Duration

+ type Component interface

+ Handle func(Session, Event) Component

+ Render func() node.Node

+ func Route(comp Component, prefix string, sess Session, ev Event) Component

+ type ComponentMount interface

+ func Mount[S any, C Component](prefix string, getter func(S) C, setter func(S, C) S) ComponentMount[S]

+ type Diagnostic struct

+ Detail string

+ Err error

+ Kind DiagnosticKind

+ SessionID string

+ type DiagnosticKind string

+ const BufferOverflow

+ const CommandDiscarded

+ const CommandDropped

+ const EncodeError

+ const HandlerPanic

+ const NavigateRedirectLoop

+ const SessionBindingFailed

+ const SessionStoreError

+ const StoreError

+ const TransportError

+ const UploadError

+ const UploadRejected

+ type DiffStore interface

+ Delete func(ctx context.Context, id string) error

+ Load func(ctx context.Context, id string) ([]byte, error)

+ Save func(ctx context.Context, id string, data []byte) error

+ type Drainable interface

+ Drain func(ctx context.Context) error

+ Shutdown func(ctx context.Context) error

+ type Effects struct

+ Announce string

+ Flash map[string]string

+ Replace bool

+ Signals map[string]any

+ Title string

+ Toast string

+ URL string

+ func (fx *Effects) Any() bool

+ type EqualComponent interface

+ EqualComponent func(Component) bool

+ type Event struct

+ Action string

+ Data map[string]string

+ EventID string

+ Target string

+ Type event.Type

+ func (e Event) Bind(dest any) error

+ func (e Event) Bool(key string) bool

+ func (e Event) Float64(key string) (float64, error)

+ func (e Event) Get(key string) (string, bool)

+ func (e Event) Int(key string) (int, error)

+ func (e Event) Key() string

+ func (e Event) Value() string

+ func (e Event) WithAction(action string) Event

+ type FreezeMode int

+ const FreezeWithConnect

+ const FreezeWithRestore

+ type Group struct

+ OnJoin func(session *StatefulSession[S])

+ OnLeave func(session *StatefulSession[S])

+ func NewGroup[S any]() *Group[S]

+ func (g *Group[S]) Add(s *StatefulSession[S])

+ func (g *Group[S]) All() iter.Seq[*StatefulSession[S]]

+ func (g *Group[S]) Broadcast(fn func(target *StatefulSession[S], state S) S)

+ func (g *Group[S]) BroadcastOthers(exclude Session, fn func(target *StatefulSession[S], state S) S)

+ func (g *Group[S]) Len() int

+ func (g *Group[S]) Remove(s *StatefulSession[S])

+ type HandleFunc func(session Session, state S, event Event) S

+ func Chain[S any](h HandleFunc[S], mw []Middleware[S]) HandleFunc[S]

+ type Handler struct

+ Diagnostics *Bus[Diagnostic]

+ func Stateful[S any](app App, cfg StatefulConfig[S]) *Handler[S]

+ func (h *Handler[S]) Drain(ctx context.Context) error

+ func (h *Handler[S]) Health() HealthStatus

+ func (h *Handler[S]) ListenAndServe(addr string, handler ...http.Handler) error

+ func (h *Handler[S]) ListenAndServeTLS(addr, certFile, keyFile string, handler ...http.Handler) error

+ func (h *Handler[S]) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (h *Handler[S]) Shutdown(ctx context.Context) error

+ type HealthStatus struct

+ Active int

+ Disconnected int

+ Pending int

+ type Heartbeater interface

+ StartHeartbeat func(interval time.Duration)

+ type Limits struct

+ CmdBufferSize int

+ MaxEventBytes int64

+ MaxPending int

+ MaxPushSubscriptionBytes int64

+ MaxSessions int

+ type Middleware func(HandleFunc[S]) HandleFunc[S]

+ type Mounter interface

+ Mount func(Session) Component

+ type NoPatch struct

+ Action string

+ Source string

+ type Params struct

+ Path string

+ Query url.Values

+ func (p Params) Bool(key string) bool

+ func (p Params) BoolDefault(key string, def bool) bool

+ func (p Params) Float64(key string) (float64, error)

+ func (p Params) Float64Default(key string, def float64) float64

+ func (p Params) Float64s(key string) ([]float64, error)

+ func (p Params) Get(key string) string

+ func (p Params) Int(key string) (int, error)

+ func (p Params) IntDefault(key string, def int) int

+ func (p Params) Ints(key string) ([]int, error)

+ func (p Params) Strings(key string) []string

+ type PushConfig struct

+ OnSubscribe func(ctx context.Context, session *StatefulSession[S], sub push.Subscription)

+ Sender *push.Sender

+ type RenderFunc func(state S) node.Node

+ type Security struct

+ DisableSessionBinding bool

+ SessionMatch func(original, reconnect string) bool

+ TrustedOrigins []string

+ type Session interface

+ Announce func(text string)

+ Close func()

+ Context func() context.Context

+ Flash func(selector, text string)

+ Go func(fn func(context.Context))

+ ID func() string

+ Navigate func(rawURL string)

+ Push func(n push.Notification) error

+ ReplaceURL func(rawURL string)

+ SetTitle func(title string)

+ Signal func(key string, value any)

+ Signals func(signals map[string]any)

+ Toast func(text string)

+ type SessionCodec interface

+ Marshal func(state S) ([]byte, error)

+ Unmarshal func(data []byte) (S, error)

+ type SessionStore interface

+ Delete func(ctx context.Context, id string) error

+ Load func(ctx context.Context, id string) ([]byte, error)

+ Save func(ctx context.Context, id string, data []byte, ttl time.Duration) error

+ type StatefulConfig struct

+ Codec SessionCodec[S]

+ Components []ComponentMount[S]

+ DiffStore DiffStore

+ Equal func(a, b S) bool

+ Fallback func(w http.ResponseWriter, r *http.Request) (Transport, error)

+ Freeze FreezeMode

+ Groups []*Group[S]

+ Handle HandleFunc[S]

+ InitialState func(r *http.Request) S

+ Layout func(state S, content node.Node) node.Node

+ Limits Limits

+ Middleware []Middleware[S]

+ Mode mode.Transport

+ Name string

+ OnCommandDropped func(session *StatefulSession[S])

+ OnConnect func(session *StatefulSession[S])

+ OnDisconnect func(session *StatefulSession[S])

+ OnNavigate func(session Session, state S, params Params) S

+ OnNoPatch func(session *StatefulSession[S], info NoPatch)

+ OnPanic func(session *StatefulSession[S], err error)

+ OnRestore func(session *StatefulSession[S])

+ OnStructuralChange func(session *StatefulSession[S], change StructuralChange)

+ Protocol protocol.Protocol

+ Push *PushConfig[S]

+ Render RenderFunc[S]

+ SessionStore SessionStore

+ Timeouts Timeouts

+ Upgrade func(w http.ResponseWriter, r *http.Request) (Transport, error)

+ Upload *UploadConfig[S]

+ Watchers []Watcher[S]

+ WireFormat wire.Format

+ Worker bool

+ type StatefulSession struct

+ func (s *StatefulSession[S]) Announce(text string)

+ func (s *StatefulSession[S]) Close()

+ func (s *StatefulSession[S]) Context() context.Context

+ func (s *StatefulSession[S]) Flash(selector, text string)

+ func (s *StatefulSession[S]) Go(fn func(ctx context.Context))

+ func (s *StatefulSession[S]) ID() string

+ func (s *StatefulSession[S]) Navigate(rawURL string)

+ func (s *StatefulSession[S]) Push(n push.Notification) error

+ func (s *StatefulSession[S]) ReplaceURL(rawURL string)

+ func (s *StatefulSession[S]) SetTitle(title string)

+ func (s *StatefulSession[S]) Signal(key string, value any)

+ func (s *StatefulSession[S]) Signals(signals map[string]any)

+ func (s *StatefulSession[S]) State() S

+ func (s *StatefulSession[S]) Toast(text string)

+ func (s *StatefulSession[S]) Update(fn func(S) S)

+ type StatelessConfig struct

+ Components []ComponentMount[S]

+ Handle func(session Session, state S, event Event) S

+ InitialState func(r *http.Request) S

+ Layout func(state S, content node.Node) node.Node

+ Limits Limits

+ Middleware []Middleware[S]

+ Name string

+ OnNavigate func(session Session, state S, params Params) S

+ Render RenderFunc[S]

+ type Status int32

+ const Active

+ const Destroyed

+ const Frozen

+ const Pending

+ func (s Status) String() string

+ type StructuralChange struct

+ Added []string

+ Bytes int

+ Removed []string

+ Reordered bool

+ type Timeouts struct

+ BackoffMultiplier float64

+ DisableHeartbeat bool

+ DisableJitter bool

+ DisableReconnect bool

+ Heartbeat time.Duration

+ Idle time.Duration

+ MaxLifetime time.Duration

+ MaxRetry time.Duration

+ Pending time.Duration

+ Reconnect time.Duration

+ Retry time.Duration

+ ShutdownGrace time.Duration

+ type Transport interface

+ Close func() error

+ ReceiveEvent func() (Event, error)

+ Send func(data []byte) error

+ type Upload struct

+ Action string

+ ContentType string

+ Name string

+ Size int64

+ func (u Upload) Open() (multipart.File, error)

+ type UploadConfig struct

+ Accept []string

+ Handle func(session *StatefulSession[S], upload Upload) error

+ MaxMemory int64

+ MaxSize int64

+ type Value struct

+ func NewValue[V any](initial V) *Value[V]

+ func (v *Value[V]) Len() int

+ func (v *Value[V]) Load() V

+ func (v *Value[V]) Store(val V)

+ func (v *Value[V]) Update(fn func(V) V)

+ type Watcher interface

+ func WatchBus[S any, E any](bus *Bus[E], mapper func(E, S) S) Watcher[S]

+ func WatchValue[S any, V any](val *Value[V], mapper func(V, S) S) Watcher[S]

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL