websocket

README

websocket

Helpers for websocket clients and servers.

Examples

Server

$ go run ./examples/server/server.go
INFO[0000] Listening 127.0.0.1:3333

Documentation

Index

• Variables
• type HTTPUpgradeHandler
  • func NewHTTPUpgradeHandler(h Handler, l loggers.Logger) *HTTPUpgradeHandler
  • func (h *HTTPUpgradeHandler) ServeHTTP(rwc http.ResponseWriter, r *http.Request)
• type Handler
• type HandlerFunc
  • func (hf HandlerFunc) ServeWebsocket(rwc io.ReadWriteCloser, r *http.Request)
• type ReadWriteCloser
  • func NewReadWriteCloser(r *Reader, w *Writer, c io.Closer) ReadWriteCloser
• type Reader
  • func NewReader(c *websocket.Conn) *Reader
  • func (w *Reader) Read(buf []byte) (int, error)
• type Writer
  • func NewWriter(c *websocket.Conn) *Writer
  • func (w *Writer) Write(buf []byte) (int, error)

Variables

var (
	DefaultHeaders = http.Header{}
)

Types

type HTTPUpgradeHandler

type HTTPUpgradeHandler struct {
	Handler
	// contains filtered or unexported fields
}

HTTPUpgradeHandler is a net/http.Handler which is responsible for incomming HTTP request upgrade process and handling the upgraded request with some Handler which works only with websockets.

func NewHTTPUpgradeHandler

func NewHTTPUpgradeHandler(h Handler, l loggers.Logger) *HTTPUpgradeHandler

func (*HTTPUpgradeHandler) ServeHTTP

func (h *HTTPUpgradeHandler) ServeHTTP(rwc http.ResponseWriter, r *http.Request)

type Handler

type Handler interface {
	ServeWebsocket(w io.ReadWriteCloser, r *http.Request)
}

type HandlerFunc

type HandlerFunc func(rwc io.ReadWriteCloser, r *http.Request)

func (HandlerFunc) ServeWebsocket

func (hf HandlerFunc) ServeWebsocket(rwc io.ReadWriteCloser, r *http.Request)

type ReadWriteCloser

type ReadWriteCloser struct {
	*Reader
	*Writer
	io.Closer
}

func NewReadWriteCloser

func NewReadWriteCloser(r *Reader, w *Writer, c io.Closer) ReadWriteCloser

type Reader

type Reader struct {
	*websocket.Conn
	// contains filtered or unexported fields
}

func NewReader

func NewReader(c *websocket.Conn) *Reader

func (*Reader) Read

func (w *Reader) Read(buf []byte) (int, error)

type Writer

type Writer struct {
	*websocket.Conn
}

func NewWriter

func NewWriter(c *websocket.Conn) *Writer

func (*Writer) Write

func (w *Writer) Write(buf []byte) (int, error)