ws

Documentation

Overview

Package ws handles the websocket interface of otter

Index

• Variables
• func Init(secret string, numReaders int)
• func NewHandler() http.Handler
• type Error
• type SubListRes

Variables

var Auth auth.Auth

Auth needs to be set in order to properly handle authentication

Functions

func Init

func Init(secret string, numReaders int)

Init initializes connection routing

func NewHandler

func NewHandler() http.Handler

NewHandler returns an http.Handler which handles the websocket interface

Types

type Error

type Error struct {
	Error error `json:"error"`
}

Error is pushed to the connection when something unexpected has occurred

type SubListRes

type SubListRes struct {
	Conns []conn.Conn `json:"conns"`
}

SubListRes is the structur that the list of connection objects from a call to /subbed will be returned in