Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

broker

package

Go to main page

Versions in this module

v1

v1.7.3

Jul 22, 2026

v1.7.2

Jul 2, 2026

v1.7.1

Jul 1, 2026

v1.7.0

Jun 29, 2026

Changes in this version

+ var ErrBrokerClosed = errors.New("broker is closed")

+ var ErrInvalidPeer = errors.New("invalid peer: not created by this broker")

+ var ErrPeerClosed = errors.New("peer is closed")

+ var ErrPeerNotFound = errors.New("peer not found")

+ var ErrRoomNotFound = errors.New("room not found")

+ var ErrSendBufferFull = errors.New("send buffer full")

+ type Broker struct

+ func New(handler Handler, opts ...Option) *Broker

+ func (b *Broker) Accept(transport Transport) (Peer, error)

+ func (b *Broker) Broadcast(msg *Message)

+ func (b *Broker) CreateRoom() *Room

+ func (b *Broker) Events() *eventBus

+ func (b *Broker) JoinRoom(roomID string, p Peer) error

+ func (b *Broker) LeaveRoom(p Peer)

+ func (b *Broker) Peer(id string) Peer

+ func (b *Broker) Peers() []Peer

+ func (b *Broker) Room(id string) *Room

+ func (b *Broker) Rooms() map[string]*Room

+ func (b *Broker) SendTo(peerID string, msg *Message) error

+ func (b *Broker) SendToRoom(roomID string, msg *Message, exclude Peer)

+ func (b *Broker) Start(ctx context.Context)

+ func (b *Broker) Stop() error

+ type Event struct

+ Msg *Message

+ Peer Peer

+ Room *Room

+ Type EventType

+ type EventHandler func(Event)

+ type EventType int

+ const EventMessageReceived

+ const EventPeerConnected

+ const EventPeerDisconnected

+ const EventPeerJoinedRoom

+ const EventPeerLeftRoom

+ type Handler interface

+ HandleDisconnect func(from Peer)

+ HandleMessage func(from Peer, msg *Message)

+ type Message struct

+ Payload map[string]any

+ To string

+ Type string

+ func NewMessage(typ string) *Message

+ func UnmarshalMessage(data []byte) (*Message, error)

+ func (m *Message) Marshal() []byte

+ type Option func(*Options)

+ func WithChannelBufSize(size int) Option

+ func WithLogger(l logger.Logger) Option

+ func WithMaxMessageSize(size int) Option

+ func WithPeerIDGenerator(gen func() string) Option

+ func WithRoomAutoCleanup(enabled bool) Option

+ func WithSendBufSize(size int) Option

+ type Options struct

+ ChannelBufSize int

+ Logger logger.Logger

+ MaxMessageSize int

+ PeerIDGenerator func() string

+ RoomAutoCleanup bool

+ SendBufSize int

+ type Peer interface

+ Close func() error

+ ID func() string

+ Metadata func() map[string]any

+ RemoteAddr func() string

+ RoomID func() string

+ Send func(msg *Message) error

+ SetMetadata func(key string, value any)

+ type Room struct

+ func (r *Room) Add(p Peer)

+ func (r *Room) Broadcast(msg *Message)

+ func (r *Room) ID() string

+ func (r *Room) Peers() []Peer

+ func (r *Room) Remove(p Peer)

+ func (r *Room) Size() int

+ type Transport interface

+ Close func() error

+ ReadMessage func() ([]byte, error)

+ RemoteAddr func() string

+ WriteMessage func([]byte) error