realtime

Documentation

Overview

Package realtime declares the browser presentation-event realtime compiler capability and exposes dependency-free SSE helpers.

Index

• Constants
• func Addon() gowdk.Addon
• type PresentationFanout
• type SSEHub
  • func NewSSE(options ...SSEOption) *SSEHub
• type SSEOption
  • func WithSSEBufferSize(size int) SSEOption

Constants

const ImportPath = "github.com/cssbruno/gowdk/addons/realtime"

ImportPath is the canonical Go import path for the realtime addon.

Functions

func Addon

func Addon() gowdk.Addon

Addon enables realtime presentation-event fanout support.

Types

type PresentationFanout

type PresentationFanout = contracts.PresentationFanout

PresentationFanout sends browser-facing presentation events.

type SSEHub

type SSEHub = runtimerealtime.SSEHub

SSEHub fans presentation events out to connected server-sent events clients.

func NewSSE

func NewSSE(options ...SSEOption) *SSEHub

NewSSE creates a dependency-free server-sent events presentation fanout hub.

type SSEOption

type SSEOption = runtimerealtime.SSEOption

SSEOption configures a dependency-free SSE hub.

func WithSSEBufferSize

func WithSSEBufferSize(size int) SSEOption

WithSSEBufferSize sets each SSE client's queued message buffer.