channel

Documentation

Index

• Variables
• func Handler(myAPI *api.API) http.Handler
• func ProxyChannel(w http.ResponseWriter, r *http.Request, settings *api.ChannelSettings, ...)
• type AuthChecker
  • func NewAuthChecker(f AuthCheckerFunc, template *api.ChannelSettings, stopCh chan error) *AuthChecker
  • func (c *AuthChecker) Close() error
  • func (c *AuthChecker) Loop(interval time.Duration)
• type AuthCheckerFunc
• type Connection
  • func Wrap(conn Connection, subprotocol string) Connection
• type Proxy
  • func NewProxy(stoppers int) *Proxy
  • func (p *Proxy) Serve(upstream, downstream Connection, upstreamAddr, downstreamAddr string) error

Variables

var (
	ReauthenticationInterval = 5 * time.Minute
	BrowserPingInterval      = 30 * time.Second
)

var ErrAuthChanged = errors.New("connection closed: authentication changed or endpoint unavailable")

Functions

func Handler

func Handler(myAPI *api.API) http.Handler

func ProxyChannel

func ProxyChannel(w http.ResponseWriter, r *http.Request, settings *api.ChannelSettings, proxy *Proxy)

Types

type AuthChecker

type AuthChecker struct {
	Checker  AuthCheckerFunc
	Template *api.ChannelSettings
	StopCh   chan error
	Done     chan struct{}
	Count    int64
}

Regularly checks that authorization is still valid for a channel, outputting to the stopper when it isn't

func NewAuthChecker

func NewAuthChecker(f AuthCheckerFunc, template *api.ChannelSettings, stopCh chan error) *AuthChecker

func (*AuthChecker) Close

func (c *AuthChecker) Close() error

func (*AuthChecker) Loop

func (c *AuthChecker) Loop(interval time.Duration)

type AuthCheckerFunc

type AuthCheckerFunc func() *api.ChannelSettings

type Connection

type Connection interface {
	UnderlyingConn() net.Conn
	ReadMessage() (int, []byte, error)
	WriteMessage(int, []byte) error
	WriteControl(int, []byte, time.Time) error
}

An abstraction of gorilla's *websocket.Conn

func Wrap

func Wrap(conn Connection, subprotocol string) Connection

type Proxy

type Proxy struct {
	StopCh chan error
}

func NewProxy

func NewProxy(stoppers int) *Proxy

stoppers is the number of goroutines that may attempt to call Stop()

func (*Proxy) Serve

func (p *Proxy) Serve(upstream, downstream Connection, upstreamAddr, downstreamAddr string) error