natsmqtt5

Nov 1, 2026

Changes in this version

type Options

+ AwayBufferMessages int

Nov 1, 2026

Changes in this version

type Options

+ CloseBehindClients bool

+ DurablePublishDedupe bool

+ NATSIngest bool

+ PinDurableWills *bool

+ PinOutboundTopicAliases *bool

+ PinRestrictDollarTopics *bool

+ PublisherClockExpiry bool

+ ReconnectCatchUp bool

+ RetainedVerifyInterval time.Duration

Oct 31, 2026

Changes in this version

+ var ErrBadAuthMethod = errors.New("natsmqtt5: unsupported authentication method")

+ type AuthBegin struct

+ ClientID string

+ Data []byte

+ Identity string

+ Method string

+ Reauth bool

+ RemoteAddr net.Addr

+ TLS *tls.ConnectionState

+ Username string

+ type AuthExchange interface

+ Next func(ctx context.Context, data []byte) (AuthStep, error)

+ type AuthStep struct

+ AssignClientID string

+ Data []byte

+ Done bool

+ Identity string

+ type Auther interface

+ BeginAuth func(ctx context.Context, req *AuthBegin) (AuthExchange, error)

type Broker

+ func (b *Broker) WebSocketHandler() http.Handler

type Options

+ Auther Auther

+ EscapeNATSWildcards bool

+ OutboundTopicAliases bool

+ SharedQoS2 bool

+ WebSocketOriginPatterns []string

Oct 13, 2026

Changes in this version

+ const DefaultRetainedTombstoneTTL

+ const DroppedFilterProperty

+ var ErrAuthorizerUnavailable = errors.New("natsmqtt5: the Authorizer could not decide")

type Broker

+ func (b *Broker) OfflineQueueActive() bool

type Options

+ OfflineQueueRewind time.Duration

+ RetainedTombstoneTTL time.Duration

+ SharedHoldLimit time.Duration

Oct 8, 2026

Changes in this version

+ const DefaultSessionCheckpointInterval

type Options

+ SessionCheckpointInterval time.Duration

Oct 8, 2026

Changes in this version

+ const DefaultSessionSweepInterval

type Options

+ DurablePublish bool

+ DurableWills bool

+ RestrictDollarTopics bool

+ SessionSweepInterval time.Duration

+ WillCheckInterval time.Duration

Oct 7, 2026

Changes in this version

type Options

+ DisableOfflineQueue bool

Oct 4, 2026

Changes in this version

type Options

+ OfflineQueue bool

+ OfflineQueueMaxAge time.Duration

+ OfflineQueueReplicas int

+ OfflineQueueStorage jetstream.StorageType

Oct 4, 2026

Changes in this version

+ const ReauthorizeForwardWait

Oct 4, 2026

Changes in this version

type Broker

+ func (b *Broker) Reauthorize(ctx context.Context, clientID string) error

Sep 27, 2026

Changes in this version

type AuthzRequest

+ Will bool

Sep 26, 2026

Changes in this version

type AuthzRequest

+ Resume bool

Sep 13, 2026

Changes in this version

+ const MaxPersistentClientIDLen

type Options

+ PersistentSessions bool

+ SessionReplicas int

+ SessionStorage jetstream.StorageType

Sep 12, 2026

Changes in this version

+ const DefaultConnectTimeout

+ const DefaultListen

+ const DefaultMaxSessionExpiry

+ const DefaultMaximumPacketSize

+ const DefaultReceiveMaximum

+ const DefaultStreamPrefix

+ const DefaultSubjectPrefix

+ const DefaultTopicAliasMaximum

+ var ErrInvalidOptions = errors.New("natsmqtt5: invalid options")

+ func Ptr[T any](v T) *T

+ type Action int

+ const ActionPublish

+ const ActionSubscribe

+ func (a Action) String() string

+ type AuthRequest struct

+ ClientID string

+ Password []byte

+ Properties *packet.Properties

+ RemoteAddr net.Addr

+ TLS *tls.ConnectionState

+ Username string

+ type AuthResult struct

+ AssignClientID string

+ Identity string

+ type Authenticator interface

+ Authenticate func(ctx context.Context, req *AuthRequest) (*AuthResult, error)

+ type AuthenticatorFunc func(ctx context.Context, req *AuthRequest) (*AuthResult, error)

+ func (f AuthenticatorFunc) Authenticate(ctx context.Context, req *AuthRequest) (*AuthResult, error)

+ type Authorizer interface

+ Authorize func(ctx context.Context, req *AuthzRequest) error

+ type AuthorizerFunc func(ctx context.Context, req *AuthzRequest) error

+ func (f AuthorizerFunc) Authorize(ctx context.Context, req *AuthzRequest) error

+ type AuthzRequest struct

+ Action Action

+ ClientID string

+ Identity string

+ QoS packet.QoS

+ Retain bool

+ Topic string

+ Username string

+ type Broker struct

+ func New(opts Options) (*Broker, error)

+ func NewWithContext(ctx context.Context, opts Options) (*Broker, error)

+ func (b *Broker) Close() error

+ func (b *Broker) ListenAddr() net.Addr

+ func (b *Broker) NATS() *nats.Conn

+ func (b *Broker) Serve(ctx context.Context) error

+ type ConnectError struct

+ Code packet.ReasonCode

+ Reason string

+ func (e *ConnectError) Error() string

+ type Options struct

+ Authenticator Authenticator

+ Authorizer Authorizer

+ Conn *nats.Conn

+ ConnectTimeout time.Duration

+ DisableRetained bool

+ Listen string

+ Listener net.Listener

+ Logger *slog.Logger

+ MaxSessionExpiry time.Duration

+ MaximumPacketSize uint32

+ MaximumQoS *uint8

+ NATSOptions []nats.Option

+ NATSURL string

+ ReceiveMaximum uint16

+ RetainedReplicas int

+ RetainedStorage jetstream.StorageType

+ ServerKeepAlive uint16

+ StreamPrefix string

+ SubjectPrefix string

+ TLSConfig *tls.Config

+ TopicAliasMaximum *uint16