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
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

herald

package module

Go to main page

Versions in this module

v1

v1.2.0

Feb 1, 2026

Changes in this version

+ type HandlerFunc func(*MessageContext, *Message)

v1.1.0

Feb 1, 2026

Changes in this version

+ const MessageTimeout

+ const PeerConnectingTimeout

+ var ErrAckTimeout = errors.New("ack timeout")

+ var ErrInvalidEventType = errors.New("invalid event type")

+ var ErrInvalidMessage = errors.New("invalid message")

+ var ErrMessageTimeout = errors.New("message timeout")

+ var ErrSelfMessage = errors.New("self message")

type Herald

+ func (h *Herald) Broadcast(ctx context.Context, payload []byte)

+ type Log interface

+ Debug func(ctx context.Context, msg string, args ...any)

+ Error func(ctx context.Context, msg string, args ...any)

+ Info func(ctx context.Context, msg string, args ...any)

+ Warn func(ctx context.Context, msg string, args ...any)

+ func NewDiscardLogs() Log

+ func NewLogger(option *slog.HandlerOptions) Log

+ func NewLogs(logger *slog.Logger) Log

+ type Option struct

+ Logger Log

v1.0.1

Jan 6, 2026

Changes in this version

+ const PeerTimeout

+ var ErrInvalidSignature = errors.New("invalid signature")

+ var ErrUnauthorized = errors.New("unauthorized")

+ var ErrUnknownPeer = errors.New("unknown peer")

+ type Handler interface

+ Handle func(context.Context, *Herald, *message.Envelope) error

+ type Herald struct

+ func New(transport transport.Transport, privateKey []byte) *Herald

+ func (h *Herald) Close(ctx context.Context) error

+ func (h *Herald) ID() string

+ func (h *Herald) OnPeerJoin(hook PeerHook)

+ func (h *Herald) OnPeerLeave(hook PeerHook)

+ func (h *Herald) Peers() []string

+ func (h *Herald) Send(ctx context.Context, msg Message)

+ func (h *Herald) SendAndWait(ctx context.Context, peerID string, payload map[string]any, ...) error

+ func (h *Herald) SendMessage(ctx context.Context, msg string)

+ func (h *Herald) SendPayload(ctx context.Context, payload map[string]any)

+ func (h *Herald) SendToPeer(ctx context.Context, peerID string, payload map[string]any) error

+ func (h *Herald) Start(ctx context.Context) error

+ func (h *Herald) Subscribe(ctx context.Context, event MessageType, buffer int) Subscription

+ type Hook struct

+ OnPeerJoin []PeerHook

+ OnPeerLeave []PeerHook

+ type Message struct

+ From string

+ ID string

+ Payload map[string]any

+ To string

+ Type MessageType

+ type MessageContext struct

+ func NewMessageContext(ctx context.Context) *MessageContext

+ func (ctx *MessageContext) Abort()

+ func (ctx *MessageContext) IsAborted() bool

+ type MessageType string

+ const MessageTypeACK

+ const MessageTypeAnnounce

+ const MessageTypeMessage

+ const MessageTypeOffline

+ func (mt MessageType) GetType() message.EventType

+ type Middleware func(ctx *MessageContext, herald *Herald, env *message.Envelope) error

+ func CheckMessageAccess() Middleware

+ func UpdateLastOnline() Middleware

+ func VerifySignature() Middleware

+ type PeerHook func(ctx context.Context, peerID string)

+ type Subscription struct

+ C <-chan Message

v1.0.0

Jan 6, 2026