mercure

Jun 1, 2026

Changes in this version

+ var ErrInvalidEventID = errors.New(`"id" field contains a forbidden control character`)

+ var ErrInvalidEventType = errors.New(`"type" field contains a forbidden control character`)

+ var ErrReservedTopic = errors.New(`topic value references the reserved "/.well-known/mercure" namespace`)

+ var ErrTooManyClaimMatchers = errors.New("too many matchers in mercure claim")

+ var ErrTooManyTopics = errors.New("too many topics in update")

type Update

+ func (u *Update) Validate() error

May 11, 2026

Changes in this version

type Update

+ func (u *Update) SpanAttributes() []attribute.KeyValue

Apr 17, 2026

Changes in this version

+ type TransportHealthChecker interface

+ Live func(ctx context.Context) error

+ Ready func(ctx context.Context) error

Apr 8, 2026

Changes in this version

+ const DefaultTopicSelectorStoreCacheSize

Nov 10, 2025

Changes in this version

+ const DefaultSubscriberListCacheSize

+ const DefaultTopicSelectorStoreCacheMaxEntriesPerShard

+ const DefaultTopicSelectorStoreCacheShardCount

+ var SubscriberContextKey subscriberContextKeyType

+ var UpdateContextKey updateContextKeyType

+ func NewSlogHandler(handler slog.Handler) slog.Handler

type Hub

+ func (h *Hub) Publish(ctx context.Context, update *Update) error

type Subscriber

+ func (s *Subscriber) LogValue() slog.Value

type TopicSelectorStore

+ func NewTopicSelectorStoreCache(maxEntriesPerShard int, shardCount uint64) (*TopicSelectorStore, error)

type Update

+ func (u *Update) AssignUUID()

+ func (u *Update) LogValue() slog.Value

Nov 10, 2024

Changes in this version

+ type LocalSubscriber struct

+ func NewLocalSubscriber(lastEventID string, logger Logger, topicSelectorStore *TopicSelectorStore) *LocalSubscriber

+ func (s *LocalSubscriber) Disconnect()

+ func (s *LocalSubscriber) Dispatch(u *Update, fromHistory bool) bool

+ func (s *LocalSubscriber) HistoryDispatched(responseLastEventID string)

+ func (s *LocalSubscriber) Ready() (n int)

+ func (s *LocalSubscriber) Receive() <-chan *Update

type Transport

+ func DeprecatedNewBoltTransport(u *url.URL, l Logger) (Transport, error)

+ func DeprecatedNewLocalTransport(_ *url.URL, _ Logger) (Transport, error)

+ type TransportTopicSelectorStore interface

+ SetTopicSelectorStore func(store *TopicSelectorStore)

Apr 8, 2024

Changes in this version

type Option

+ func WithPublisherJWTKeyFunc(keyfunc jwt.Keyfunc) Option

+ func WithSubscriberJWTKeyFunc(keyfunc jwt.Keyfunc) Option

Aug 3, 2023

Changes in this version

type Logger

+ Level func() Level

May 17, 2023

retracted

Changes in this version

+ const DefaultDispatchTimeout

+ const DefaultHeartbeat

+ const DefaultWriteTimeout

Sep 6, 2022

Changes in this version

+ const DefaultTopicSelectorStoreLRUMaxEntriesPerShard

+ const DefaultTopicSelectorStoreLRUShardCount

+ const TopicSelectorStoreRistrettoCacheMaxCost

+ const TopicSelectorStoreRistrettoDefaultCacheNumCounters

+ var ErrInvalidAuthorizationQuery = errors.New(`invalid "authorization" Query parameter`)

+ var ErrUnsupportedProtocolVersion = errors.New("compatibility mode only supports protocol version 7")

type BoltTransport

+ func (t *BoltTransport) RemoveSubscriber(s *Subscriber) error

type Hub

+ func (h *Hub) Demo(w http.ResponseWriter, r *http.Request)

type LocalTransport

+ func (t *LocalTransport) RemoveSubscriber(s *Subscriber) error

type Option

+ func WithCookieName(cookieName string) Option

+ func WithProtocolVersionCompatibility(protocolVersionCompatibility int) Option

type Subscriber

+ AllowedPrivateRegexps []*regexp.Regexp

+ AllowedPrivateTopics []string

+ SubscribedTopicRegexps []*regexp.Regexp

+ SubscribedTopics []string

+ func (s *Subscriber) Match(u *Update) bool

+ func (s *Subscriber) MatchTopics(topics []string, private bool) bool

+ func (s *Subscriber) Ready() int

+ func (s *Subscriber) SetTopics(subscribedTopics, allowedPrivateTopics []string)

+ type SubscriberList struct

+ func NewSubscriberList(size int) *SubscriberList

+ func (sl *SubscriberList) Add(s *Subscriber)

+ func (sl *SubscriberList) Len() int

+ func (sl *SubscriberList) MatchAny(u *Update) (res []*Subscriber)

+ func (sl *SubscriberList) Remove(s *Subscriber)

+ func (sl *SubscriberList) Walk(start uint64, callback func(s *Subscriber) bool) uint64

type TopicSelectorStore

+ func NewTopicSelectorStoreLRU(maxEntriesPerShard, shardCount int64) (*TopicSelectorStore, error)

+ func NewTopicSelectorStoreRistretto(cacheNumCounters, cacheMaxCost int64) (*TopicSelectorStore, error)

+ type TopicSelectorStoreCache interface

+ Get func(interface{}) (interface{}, bool)

+ Set func(interface{}, interface{}, int64) bool

type Transport

+ RemoveSubscriber func(s *Subscriber) error

Oct 11, 2021

Changes in this version

+ type CheckedEntry = zapcore.CheckedEntry

+ type Level = zapcore.Level

type Logger

+ Check func(Level, string) *CheckedEntry

Aug 24, 2021

Changes in this version

+ type TransportError struct

+ func (e *TransportError) Error() string

+ func (e *TransportError) Unwrap() error

Jul 11, 2021

Changes in this version

type Option

+ func WithUI() Option

Mar 1, 2021

Changes in this version

type Hub

+ func (h *Hub) Stop() error

Jan 19, 2021

Changes in this version

+ const BoltDefaultCleanupFrequency

+ const EarliestLastEventID

+ const TopicSelectorStoreCacheMaxCost

+ const TopicSelectorStoreDefaultCacheNumCounters

+ var ErrClosedTransport = errors.New("hub: read/write on closed Transport")

+ var ErrInvalidAuthorizationHeader = errors.New(`invalid "Authorization" HTTP header`)

+ var ErrInvalidConfig = errors.New("invalid config")

+ var ErrInvalidJWT = errors.New("invalid JWT")

+ var ErrNoOrigin = errors.New(...)

+ var ErrOriginNotAllowed = errors.New("origin not allowed to post updates")

+ var ErrPublicKey = errors.New("public key error")

+ var ErrUnexpectedSigningMethod = errors.New("unexpected signing method")

+ func AssignUUID(u *Update)

+ func Demo(w http.ResponseWriter, r *http.Request)

+ func InitConfig(v *viper.Viper)

+ func RegisterTransportFactory(scheme string, factory TransportFactory)

+ func SetConfigDefaults(v *viper.Viper)

+ func SetFlags(fs *pflag.FlagSet, v *viper.Viper)

+ func Start()

+ func ValidateConfig(v *viper.Viper) error

+ type BoltTransport struct

+ func (t *BoltTransport) AddSubscriber(s *Subscriber) error

+ func (t *BoltTransport) Close() (err error)

+ func (t *BoltTransport) Dispatch(update *Update) error

+ func (t *BoltTransport) GetSubscribers() (string, []*Subscriber, error)

+ type ErrTransport struct

+ func (e *ErrTransport) Error() string

+ func (e *ErrTransport) Unwrap() error

+ type Event struct

+ Data string

+ ID string

+ Retry uint64

+ Type string

+ func (e *Event) String() string

+ type Hub struct

+ func NewHub(options ...Option) (*Hub, error)

+ func NewHubFromViper(v *viper.Viper) (*Hub, error)

+ func (h *Hub) PublishHandler(w http.ResponseWriter, r *http.Request)

+ func (h *Hub) Serve()

+ func (h *Hub) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (h *Hub) SubscribeHandler(w http.ResponseWriter, r *http.Request)

+ func (h *Hub) SubscriptionHandler(w http.ResponseWriter, r *http.Request)

+ func (h *Hub) SubscriptionsHandler(w http.ResponseWriter, r *http.Request)

+ type LocalTransport struct

+ func (t *LocalTransport) AddSubscriber(s *Subscriber) error

+ func (t *LocalTransport) Close() (err error)

+ func (t *LocalTransport) Dispatch(update *Update) error

+ func (t *LocalTransport) GetSubscribers() (string, []*Subscriber, error)

+ type LogField = zapcore.Field

+ type Logger interface

+ Debug func(msg string, fields ...LogField)

+ Error func(msg string, fields ...LogField)

+ Info func(msg string, fields ...LogField)

+ Warn func(msg string, fields ...LogField)

+ type Metrics interface

+ SubscriberConnected func(s *Subscriber)

+ SubscriberDisconnected func(s *Subscriber)

+ UpdatePublished func(u *Update)

+ type NopMetrics struct

+ func (NopMetrics) SubscriberConnected(s *Subscriber)

+ func (NopMetrics) SubscriberDisconnected(s *Subscriber)

+ func (NopMetrics) UpdatePublished(s *Update)

+ type Option func(h *opt) error

+ func WithAllowedHosts(hosts []string) Option

+ func WithAnonymous() Option

+ func WithCORSOrigins(origins []string) Option

+ func WithDebug() Option

+ func WithDemo(uiPath string) Option

+ func WithDispatchTimeout(timeout time.Duration) Option

+ func WithHeartbeat(interval time.Duration) Option

+ func WithLogger(logger Logger) Option

+ func WithMetrics(m Metrics) Option

+ func WithPublishOrigins(origins []string) Option

+ func WithPublisherJWT(key []byte, alg string) Option

+ func WithSubscriberJWT(key []byte, alg string) Option

+ func WithSubscriptions() Option

+ func WithTopicSelectorStore(tss *TopicSelectorStore) Option

+ func WithTransport(t Transport) Option

+ func WithWriteTimeout(timeout time.Duration) Option

+ type PrometheusMetrics struct

+ func NewPrometheusMetrics(registry prometheus.Registerer) *PrometheusMetrics

+ func (m *PrometheusMetrics) Register(r *mux.Router)

+ func (m *PrometheusMetrics) SubscriberConnected(s *Subscriber)

+ func (m *PrometheusMetrics) SubscriberDisconnected(s *Subscriber)

+ func (m *PrometheusMetrics) UpdatePublished(u *Update)

+ type Subscriber struct

+ Claims *claims

+ Debug bool

+ EscapedID string

+ EscapedTopics []string

+ ID string

+ RemoteAddr string

+ RequestLastEventID string

+ TopicSelectors []string

+ Topics []string

+ func NewSubscriber(lastEventID string, logger Logger, tss *TopicSelectorStore) *Subscriber

+ func (s *Subscriber) CanDispatch(u *Update) bool

+ func (s *Subscriber) Disconnect()

+ func (s *Subscriber) Dispatch(u *Update, fromHistory bool) bool

+ func (s *Subscriber) HistoryDispatched(responseLastEventID string)

+ func (s *Subscriber) MarshalLogObject(enc zapcore.ObjectEncoder) error

+ func (s *Subscriber) Receive() <-chan *Update

+ type TopicSelectorStore struct

+ func NewTopicSelectorStore(cacheNumCounters, cacheMaxCost int64) (*TopicSelectorStore, error)

+ type Transport interface

+ AddSubscriber func(s *Subscriber) error

+ Close func() error

+ Dispatch func(update *Update) error

+ func NewBoltTransport(u *url.URL, l Logger, tss *TopicSelectorStore) (Transport, error)

+ func NewLocalTransport(u *url.URL, l Logger, tss *TopicSelectorStore) (Transport, error)

+ func NewTransport(u *url.URL, l Logger, tss *TopicSelectorStore) (Transport, error)

+ type TransportFactory = func(u *url.URL, l Logger, tss *TopicSelectorStore) (Transport, error)

+ type TransportSubscribers interface

+ GetSubscribers func() (string, []*Subscriber, error)

+ type Update struct

+ Debug bool

+ Private bool

+ Topics []string

+ func (u *Update) MarshalLogObject(enc zapcore.ObjectEncoder) error