caddy

Documentation

Overview

Package caddy provides a handler for Caddy Server (https://caddyserver.com/) allowing to transform any Caddy instance into a Mercure hub.

Index

• Variables
• type Bolt
  • func (Bolt) CaddyModule() caddy.ModuleInfo
  • func (b *Bolt) Cleanup() error
  • func (b *Bolt) GetTransport() mercure.Transport
  • func (b *Bolt) Provision(ctx caddy.Context) error
  • func (b *Bolt) UnmarshalCaddyfile(d *caddyfile.Dispenser) error
• type JWTConfig
• type Local
  • func (Local) CaddyModule() caddy.ModuleInfo
  • func (l *Local) Cleanup() error
  • func (l *Local) GetTransport() mercure.Transport
  • func (l *Local) Provision(_ caddy.Context) error
  • func (l *Local) UnmarshalCaddyfile(_ *caddyfile.Dispenser) error
• type Mercure
  • func (Mercure) CaddyModule() caddy.ModuleInfo
  • func (m *Mercure) Cleanup() error
  • func (m *Mercure) Provision(ctx caddy.Context) error
  • func (m Mercure) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error
  • func (m *Mercure) UnmarshalCaddyfile(d *caddyfile.Dispenser) error
• type Transport
• type TransportDestructor
  • func (d TransportDestructor[T]) Destruct() error

Variables

var (
	SubscriptionsContextKey = subscriptionsKeyType{} //nolint:gochecknoglobals
	WriteTimeoutContextKey  = writeTimeoutKeyType{}  //nolint:gochecknoglobals
)

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

var TransportUsagePool = caddy.NewUsagePool() //nolint:gochecknoglobals

Types

type Bolt

type Bolt struct {
	Path             string  `json:"path,omitempty"`
	BucketName       string  `json:"bucket_name,omitempty"`
	Size             uint64  `json:"size,omitempty"`
	CleanupFrequency float64 `json:"cleanup_frequency,omitempty"`
	// contains filtered or unexported fields
}

func (Bolt) CaddyModule

func (Bolt) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*Bolt) Cleanup

func (b *Bolt) Cleanup() error

func (*Bolt) GetTransport

func (b *Bolt) GetTransport() mercure.Transport

func (*Bolt) Provision

func (b *Bolt) Provision(ctx caddy.Context) error

Provision provisions b's configuration.

func (*Bolt) UnmarshalCaddyfile

func (b *Bolt) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile sets up the handler from Caddyfile tokens.

type JWTConfig

type JWTConfig struct {
	Key string `json:"key,omitempty"`
	Alg string `json:"alg,omitempty"`
}

type Local

type Local struct {
	// contains filtered or unexported fields
}

func (Local) CaddyModule

func (Local) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*Local) Cleanup

func (l *Local) Cleanup() error

func (*Local) GetTransport

func (l *Local) GetTransport() mercure.Transport

func (*Local) Provision

func (l *Local) Provision(_ caddy.Context) error

Provision provisions l's configuration.

func (*Local) UnmarshalCaddyfile

func (l *Local) UnmarshalCaddyfile(_ *caddyfile.Dispenser) error

UnmarshalCaddyfile sets up the handler from Caddyfile tokens.

type Mercure

type Mercure struct {
	// Allow subscribers with no valid JWT.
	Anonymous bool `json:"anonymous,omitempty"`

	// Dispatch updates when subscriptions are created or terminated
	Subscriptions bool `json:"subscriptions,omitempty"`

	// Enable the demo.
	Demo bool `json:"demo,omitempty"`

	// Enable the UI.
	UI bool `json:"ui,omitempty"`

	// Maximum duration before closing the connection, defaults to 600s, set to 0 to disable.
	WriteTimeout *caddy.Duration `json:"write_timeout,omitempty"`

	// Maximum dispatch duration of an update, defaults to 5s.
	DispatchTimeout *caddy.Duration `json:"dispatch_timeout,omitempty"`

	// Frequency of the heartbeat, defaults to 40s.
	Heartbeat *caddy.Duration `json:"heartbeat,omitempty"`

	// JWT key and signing algorithm to use for publishers.
	PublisherJWT JWTConfig `json:"publisher_jwt,omitempty"`

	// JWK Set URL to use for publishers.
	PublisherJWKSURL string `json:"publisher_jwks_url,omitempty"`

	// JWT key and signing algorithm to use for subscribers.
	SubscriberJWT JWTConfig `json:"subscriber_jwt,omitempty"`

	// JWK Set URL to use for subscribers.
	SubscriberJWKSURL string `json:"subscriber_jwks_url,omitempty"`

	// Origins allowed to publish updates
	PublishOrigins []string `json:"publish_origins,omitempty"`

	// Allowed CORS origins.
	CORSOrigins []string `json:"cors_origins,omitempty"`

	// Transport to use.
	//
	// Deprecated: use transports Caddy modules.
	TransportURL string `json:"transport_url,omitempty"`

	// Triggers use of LRU topic selector cache and avoidance of select priority queue (recommend 10,000 - 1,000,000)
	LRUShardSize *int64 `json:"lru_shard_size,omitempty"`

	// The name of the authorization cookie. Defaults to "mercureAuthorization".
	CookieName string `json:"cookie_name,omitempty"`

	// The version of the Mercure protocol to be backward compatible with (only version 7 is supported)
	ProtocolVersionCompatibility int `json:"protocol_version_compatibility,omitempty"`

	// The transport configuration.
	TransportRaw json.RawMessage `json:"transport,omitempty" caddy:"namespace=http.handlers.mercure inline_key=name"` //nolint:tagalign
	// contains filtered or unexported fields
}

Mercure implements a Mercure hub as a Caddy module. Mercure is a protocol allowing to push data updates to web browsers and other HTTP clients in a convenient, fast, reliable and battery-efficient way.

func (Mercure) CaddyModule

func (Mercure) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*Mercure) Cleanup

func (m *Mercure) Cleanup() error

Deprecated: use transports Caddy modules.

func (*Mercure) Provision

func (m *Mercure) Provision(ctx caddy.Context) error

func (Mercure) ServeHTTP

func (m Mercure) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error

func (*Mercure) UnmarshalCaddyfile

func (m *Mercure) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile sets up the handler from Caddyfile tokens.

type Transport

type Transport interface {
	GetTransport() mercure.Transport
}

type TransportDestructor

type TransportDestructor[T mercure.Transport] struct {
	Transport T
}

func (TransportDestructor[T]) Destruct

func (d TransportDestructor[T]) Destruct() error