ws

package

v0.0.0-...-541d478 Latest Latest Go to latest Published: Aug 22, 2016 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package ws handles the websocket interface of otter

This section is empty.

View Source

var Auth auth.Auth

Auth needs to be set in order to properly handle authentication

func Init(secret string, numReaders int)

Init initializes connection routing

func NewHandler() http.Handler

NewHandler returns an http.Handler which handles the websocket interface

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

Error is pushed to the connection when something unexpected has occurred

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