ws

Documentation

Index

• func IsHandshakeError(err error) bool
• func NewSender(wsConn *websocket.Conn) (beam.Sender, error)
• func Serve(u *Upgrader, f BeamFunc) http.HandlerFunc
• type BeamFunc
• type Upgrader
  • func (u *Upgrader) Upgrade(w http.ResponseWriter, r *http.Request, responseHeader http.Header) (*http2.Server, error)

Functions

func IsHandshakeError

func IsHandshakeError(err error) bool

Returns true if a handshake error occured in websockets, which means a response has already been written to the stream.

func NewSender

func NewSender(wsConn *websocket.Conn) (beam.Sender, error)

Connect to a Beam server over a Websocket connection as a client

func Serve

func Serve(u *Upgrader, f BeamFunc) http.HandlerFunc

Handler function for serving Beam over HTTP. Will invoke f and then close the server's Beam endpoint after f returns.

Types

type BeamFunc

type BeamFunc func(beam.Receiver)

type Upgrader

type Upgrader struct {
	Upgrader websocket.Upgrader
}

Upgrade an HTTP connection to a Beam over HTTP2 over Websockets connection.

func (*Upgrader) Upgrade

func (u *Upgrader) Upgrade(w http.ResponseWriter, r *http.Request, responseHeader http.Header) (*http2.Server, error)