room

package module

Go to main page

Versions in this module

v0

v0.3.0

Oct 29, 2026

Changes in this version

+ const DefaultMaxBoardUser

+ const GuestInvite

+ const MaxInviteTTL

type Hub

+ func (h *Hub) OpenInvite(topic string, ttl time.Duration) error

+ func (h *Hub) Recheck()

type HubClient

+ func (c *HubClient) OpenInvite(ctx context.Context, topic string, ttl time.Duration) error

type HubConfig

+ AuthorizeBoard func(id string, pub ed25519.PublicKey) (person string, err error)

type HubLimits

+ BoardPeers int

+ InvitesPerMember int

type HubPeer

+ Person string

type TURNConfig

+ MaxBoardPerUser int

type TURNServer

+ func (t *TURNServer) IssueBoard(person string) TURNCreds

v0.2.2

Oct 29, 2026

v0.2.1

Oct 28, 2026

v0.2.0

Oct 28, 2026

Changes in this version

+ const DefaultLANRate

+ const DefaultMaxGuests

+ const DefaultMaxPerUser

+ const DefaultMaxTCP

+ const DefaultMaxTCPPerIP

+ const DefaultMaxTotal

+ const DefaultTURNRealm

+ const DefaultTURNTTL

+ const HubALPN

+ const MaxGuestTTL

+ const MaxHubFrame

+ const MaxLANDatagram

+ var ErrTooBigDatagram = errors.New("room: envelope too big for a LAN datagram")

+ func OnPublicNetwork(ip netip.Addr) bool

+ func SplitTCP(ln net.Listener) (hub, turn net.Listener)

+ type Carrier interface

+ Join func(topic string, deliver func(payload []byte, from netip.AddrPort), up func()) (Leg, error)

type Config

+ RelayOnly bool

+ type Hub struct

+ func NewHub(cfg HubConfig) (*Hub, error)

+ func (h *Hub) Close()

+ func (h *Hub) CloseGuest(topic string)

+ func (h *Hub) Drop(id string)

+ func (h *Hub) Local() Carrier

+ func (h *Hub) OpenGuest(topic string, ttl time.Duration) error

+ func (h *Hub) Peers() []HubPeer

+ func (h *Hub) Serve(ln net.Listener) error

+ type HubClient struct

+ func DialHub(cfg HubDialConfig) *HubClient

+ func (c *HubClient) Addr() string

+ func (c *HubClient) Carrier() Carrier

+ func (c *HubClient) Close()

+ func (c *HubClient) CloseGuest(topic string)

+ func (c *HubClient) OpenGuest(ctx context.Context, topic string, ttl time.Duration) error

+ func (c *HubClient) Server() (id string, pub ed25519.PublicKey)

+ func (c *HubClient) TURN(ctx context.Context) (TURNCreds, error)

+ func (c *HubClient) Up() bool

+ type HubConfig struct

+ AllowTopic func(c HubPeer, topic string) bool

+ Authorize func(id string, pub ed25519.PublicKey) error

+ Bridge *LAN

+ Identity Identity

+ Limits HubLimits

+ Logf func(format string, args ...any)

+ PublicUDP func() netip.AddrPort

+ Self string

+ TURN *TURNServer

+ type HubDialConfig struct

+ Addrs func() []string

+ Dial func(ctx context.Context, addr string) (net.Conn, error)

+ Expect func(id string, pub ed25519.PublicKey) error

+ GuestTopic string

+ Identity *Identity

+ Logf func(format string, args ...any)

+ OnUp func()

+ Self string

+ TURNURIs func(addr string) []string

+ type HubLimits struct

+ FailBackoff time.Duration

+ Guests int

+ GuestsPerMember int

+ Handshakes int

+ HandshakesPerIP int

+ Members int

+ PubBurst float64

+ PubRate float64

+ TopicsPerConn int

+ type HubPeer struct

+ Guest bool

+ ID string

+ Pub ed25519.PublicKey

+ Remote netip.AddrPort

+ type LAN struct

+ func OpenLAN(cfg LANConfig) (*LAN, error)

+ func (l *LAN) Carrier() Carrier

+ func (l *LAN) Close()

+ func (l *LAN) LocalAddr() net.Addr

+ func (l *LAN) Targets() []netip.AddrPort

+ type LANConfig struct

+ Conn net.PacketConn

+ Logf func(format string, args ...any)

+ MaxRate int

+ Now func() time.Time

+ Port int

+ Targets func() []netip.AddrPort

+ type Leg interface

+ Close func()

+ Publish func(to string, payload []byte) error

+ Seen func(member string, from netip.AddrPort)

+ Up func() bool

+ type LocalSubnet struct

+ Index int

+ Prefix netip.Prefix

+ func LocalSubnets() []LocalSubnet

type MemHub

+ func (h *MemHub) Carrier() Carrier

+ type MemLAN struct

+ Drop func(from, to netip.AddrPort) bool

+ func NewMemLAN() *MemLAN

+ func (n *MemLAN) Broadcast() netip.AddrPort

+ func (n *MemLAN) Conn(addr netip.AddrPort) net.PacketConn

type Relay

+ func (r *Relay) Kick()

+ func (r *Relay) TURN() []ICEServer

type RelayConfig

+ Fetch func(ctx context.Context) (TURNCreds, error)

type SignalOptions

+ OnHeard func(from string, addr netip.AddrPort)

type Signaler

+ func Open(s Secret, self string, o SignalOptions, carriers ...Carrier) (Signaler, error)

+ type TURNConfig struct

+ AllowPeer func(user string, ip netip.Addr) bool

+ Authorize func(user string) error

+ Key [32]byte

+ Logf func(format string, args ...any)

+ MaxGuests int

+ MaxPerUser int

+ MaxTCP int

+ MaxTCPPerIP int

+ MaxTotal int

+ Realm string

+ RelayIP netip.Addr

+ TCP net.Listener

+ TTL time.Duration

+ UDP net.PacketConn

+ type TURNCreds struct

+ Credential string

+ TTL time.Duration

+ URIs []string

+ Username string

+ type TURNServer struct

+ func NewTURN(cfg TURNConfig) (*TURNServer, error)

+ func (t *TURNServer) Close()

+ func (t *TURNServer) Issue(user string) TURNCreds

+ func (t *TURNServer) IssueGuest(until time.Time) TURNCreds

v0.1.0

Oct 28, 2026

Changes in this version

+ const CodeLen

+ const DefaultAuthTimeout

+ const DefaultConnectTimeout

+ const DefaultMaxAge

+ const DefaultMaxMessage

+ const DefaultMaxStreams

+ const MsgAnswer

+ const MsgBye

+ const MsgOffer

+ const MsgWant

+ const RTCPrefix

+ const RelayError

+ const RelayNone

+ const RelayOK

+ const RelayPending

+ const SyncLabel

+ var DefaultBrokers = [][]string

+ var DefaultSTUN = []ICEServer

+ var ErrBadCode = errors.New("that isn't a room code (16 letters and numbers, like ABCD-EFGH-JKMN-PQRS)")

+ var ErrClosed = errors.New("room: closed")

+ var ErrNotConnected = errors.New("not connected to the room yet")

+ var ErrRefused = errors.New("room: refused by peer")

+ var ErrReplaced = errors.New("room: replaced by a new connection")

+ var ErrTooBig = errors.New("room: message too big")

+ func CleanICEURLs(in []string) []string

+ func Decode[T any](env Envelope) (T, error)

+ func LoopbackOnly() func(*webrtc.SettingEngine)

+ func NewCode() string

+ func NormalizeCode(in string) (string, bool)

+ func WebRTCServers(list []ICEServer) []webrtc.ICEServer

+ type ByeError struct

+ Reason string

+ func (e *ByeError) Error() string

+ type Channel struct

+ func (c *Channel) Recv(ctx context.Context) ([]byte, error)

+ func (c *Channel) Send(ctx context.Context, msg []byte) error

+ type Config struct

+ Accept func(peer string, pub ed25519.PublicKey) error

+ Allow func(peer string) bool

+ AuthTimeout time.Duration

+ ConnectTimeout time.Duration

+ ICE func() []ICEServer

+ Identity Identity

+ Logf func(format string, args ...any)

+ MaxMessage int

+ MaxStreams int

+ Offerer func(peer string) bool

+ Self string

+ Tune func(*webrtc.SettingEngine)

+ type Envelope struct

+ At int64

+ Body json.RawMessage

+ From string

+ ID string

+ To string

+ Type string

+ V int

+ type ICEServer struct

+ Credential string

+ URLs []string

+ Username string

+ type Identity struct

+ Pub ed25519.PublicKey

+ Sign func(msg []byte) []byte

+ func KeyIdentity(priv ed25519.PrivateKey) Identity

+ type LocalCloseError struct

+ Reason string

+ func (e *LocalCloseError) Error() string

+ type MemHub struct

+ Tap func(topic string, payload []byte)

+ func NewMemHub() *MemHub

+ func (h *MemHub) Open(s Secret, self string, o SignalOptions) Signaler

+ func (h *MemHub) Publish(topic string, payload []byte)

+ type Mesh struct

+ func NewMesh(sig Signaler, cfg Config) (*Mesh, error)

+ func (m *Mesh) Close()

+ func (m *Mesh) Connect(peer string)

+ func (m *Mesh) OnPeer(fn func(*Peer))

+ func (m *Mesh) OnPeerDown(fn func(peer string, err error))

+ func (m *Mesh) Peer(id string) *Peer

+ func (m *Mesh) Peers() []*Peer

+ type Peer struct

+ func (p *Peer) Close(reason string)

+ func (p *Peer) Done() <-chan struct{}

+ func (p *Peer) Err() error

+ func (p *Peer) Fingerprints() (local, remote string)

+ func (p *Peer) ID() string

+ func (p *Peer) Messages() *Channel

+ func (p *Peer) OnStream(fn func(label string, s *Stream))

+ func (p *Peer) OpenStream(ctx context.Context, label string) (*Stream, error)

+ func (p *Peer) Path() string

+ func (p *Peer) Pub() ed25519.PublicKey

+ func (p *Peer) RTT() time.Duration

+ func (p *Peer) Session() string

+ type Relay struct

+ func NewRelay(cfg RelayConfig, peer string, onChange func()) *Relay

+ func (r *Relay) Servers() []ICEServer

+ func (r *Relay) Start()

+ func (r *Relay) Status() RelayStatus

+ func (r *Relay) Stop()

+ type RelayConfig struct

+ CredentialURL string

+ Logf func(format string, args ...any)

+ TurnURLs []string

+ type RelayStatus struct

+ Detail string

+ Expires int64

+ State string

+ type Secret struct

+ Key [32]byte

+ Topic string

+ func SecretFromCode(app, code string) (Secret, error)

+ func SecretFromKey(app string, ikm, info []byte) Secret

+ type SignalOptions struct

+ Brokers [][]string

+ ClientPrefix string

+ MaxAge time.Duration

+ OnConnect func()

+ OnMsg func(Envelope)

+ type Signaler interface

+ Close func()

+ Connected func() int

+ Self func() string

+ Send func(to, typ string, body any) error

+ Topic func() string

+ func OpenSignal(s Secret, self string, o SignalOptions) (Signaler, error)

+ type Stream struct

+ func (s *Stream) Close() error

+ func (s *Stream) Label() string

+ func (s *Stream) Read(p []byte) (int, error)

+ func (s *Stream) Write(p []byte) (int, error)

+ func (s *Stream) WriteContext(ctx context.Context, p []byte) (int, error)

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