pubsub

Documentation

Index

• type HTTPConfig
  • func NewHTTPConfig() HTTPConfig
• type HTTPSubscriber
  • func NewHTTPSubscriber(node Handler, config *HTTPConfig) *HTTPSubscriber
  • func (s *HTTPSubscriber) Handler(w http.ResponseWriter, r *http.Request)
  • func (s *HTTPSubscriber) Shutdown() error
  • func (s *HTTPSubscriber) Start() error
• type Handler
• type RedisConfig
  • func NewRedisConfig() RedisConfig
• type RedisSubscriber
  • func NewRedisSubscriber(node Handler, config *RedisConfig) *RedisSubscriber
  • func (s *RedisSubscriber) Shutdown() error
  • func (s *RedisSubscriber) Start() error
• type Subscriber
  • func NewSubscriber(node Handler, adapter string, redis *RedisConfig, http *HTTPConfig) (Subscriber, error)

Types

type HTTPConfig

type HTTPConfig struct {
	// Port to listen on
	Port int
	// Path for HTTP broadast
	Path string
	// Secret token to authorize requests
	Secret string
}

HTTPConfig contains HTTP pubsub adapter configuration

func NewHTTPConfig

func NewHTTPConfig() HTTPConfig

NewHTTPConfig builds a new config for HTTP pub/sub

type HTTPSubscriber

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

HTTPSubscriber represents HTTP pub/sub

func NewHTTPSubscriber

func NewHTTPSubscriber(node Handler, config *HTTPConfig) *HTTPSubscriber

NewHTTPSubscriber builds a new HTTPSubscriber struct

func (*HTTPSubscriber) Handler

func (s *HTTPSubscriber) Handler(w http.ResponseWriter, r *http.Request)

Handler processes HTTP requests

func (*HTTPSubscriber) Shutdown

func (s *HTTPSubscriber) Shutdown() error

Shutdown stops the HTTP server

func (*HTTPSubscriber) Start

func (s *HTTPSubscriber) Start() error

Start creates an HTTP server or attaches a handler to the existing one

type Handler

type Handler interface {
	HandlePubSub(json []byte)
}

type RedisConfig

type RedisConfig struct {
	// Redis instance URL or master name in case of sentinels usage
	URL string
	// Redis channel to subscribe to
	Channel string
	// List of Redis Sentinel addresses
	Sentinels string
	// Redis Sentinel discovery interval (seconds)
	SentinelDiscoveryInterval int
	// Redis keepalive ping interval (seconds)
	KeepalivePingInterval int
}

RedisConfig contains Redis pubsub adapter configuration

func NewRedisConfig

func NewRedisConfig() RedisConfig

NewRedisConfig builds a new config for Redis pubsub

type RedisSubscriber

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

RedisSubscriber contains information about Redis pubsub connection

func NewRedisSubscriber

func NewRedisSubscriber(node Handler, config *RedisConfig) *RedisSubscriber

NewRedisSubscriber returns new RedisSubscriber struct

func (*RedisSubscriber) Shutdown

func (s *RedisSubscriber) Shutdown() error

Shutdown is no-op for Redis

func (*RedisSubscriber) Start

func (s *RedisSubscriber) Start() error

Start connects to Redis and subscribes to the pubsub channel if sentinels is set it gets the the master address first

type Subscriber

type Subscriber interface {
	Start() error
	Shutdown() error
}

Subscriber is responsible for receiving broadcast messages and sending them to hub

func NewSubscriber

func NewSubscriber(node Handler, adapter string, redis *RedisConfig, http *HTTPConfig) (Subscriber, error)

NewSubscriber creates an instance of the provided adapter