websockets

Documentation

Index

• Constants
• type Config
  • func (c *Config) InitDefault() error
• type Plugin
  • func (p *Plugin) Available()
  • func (p *Plugin) Init(cfg config.Configurer, log logger.Logger, server server.Server, ...) error
  • func (p *Plugin) Middleware(next http.Handler) http.Handler
  • func (p *Plugin) Name() string
  • func (p *Plugin) Reset() error
  • func (p *Plugin) Serve() chan error
  • func (p *Plugin) Stop() error
  • func (p *Plugin) Workers() []*process.State

Constants

const (
	PluginName string = "websockets"

	RrMode          string = "RR_MODE"
	RrBroadcastPath string = "RR_BROADCAST_PATH"
)

Types

type Config

type Config struct {
	// http path for the websocket
	Path          string `mapstructure:"path"`
	AllowedOrigin string `mapstructure:"allowed_origin"`
	Broker        string `mapstructure:"broker"`

	// Pool with the workers for the websockets
	Pool *pool.Config `mapstructure:"pool"`
	// contains filtered or unexported fields
}

Config represents configuration for the ws plugin

func (*Config) InitDefault

func (c *Config) InitDefault() error

InitDefault initialize default values for the ws config

type Plugin

type Plugin struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func (*Plugin) Available

func (p *Plugin) Available()

func (*Plugin) Init

func (p *Plugin) Init(cfg config.Configurer, log logger.Logger, server server.Server, b broadcast.Broadcaster) error

func (*Plugin) Middleware

func (p *Plugin) Middleware(next http.Handler) http.Handler

func (*Plugin) Name

func (p *Plugin) Name() string

func (*Plugin) Reset

func (p *Plugin) Reset() error

Reset destroys the old pool and replaces it with new one, waiting for old pool to die

func (*Plugin) Serve

func (p *Plugin) Serve() chan error

func (*Plugin) Stop

func (p *Plugin) Stop() error

func (*Plugin) Workers

func (p *Plugin) Workers() []*process.State

Workers returns slice with the process states for the workers