gorilla

Documentation

Overview

Package gorilla implements a websocket connection by wrapping gorilla/websocket.

Index

• type Conn
  • func (*Conn) IsNormalClose(err error) bool
  • func (c *Conn) ReadMessage(m *message.Message) error
  • func (c *Conn) WriteClose(reason string) (err error)
  • func (c *Conn) WriteMessage(m message.Message) error
  • func (c *Conn) WritePing() error
• type Upgrader
  • func NewUpgrader() *Upgrader
  • func (u *Upgrader) Upgrade(w http.ResponseWriter, r *http.Request) (*Conn, error)

Types

type Conn

type Conn struct {
	*websocket.Conn
}

Conn implements the Conn interface by wrapping a gorilla/websocket Conn.

func (*Conn) IsNormalClose

func (*Conn) IsNormalClose(err error) bool

IsNormalClose determines if the error message is not an unexpected close error.

func (*Conn) ReadMessage

func (c *Conn) ReadMessage(m *message.Message) error

ReadMessage reads the next message from the GorillaConnection.

func (*Conn) WriteClose

func (c *Conn) WriteClose(reason string) (err error)

WriteClose writes a close message on the connection. The connestion is NOT closed.

func (*Conn) WriteMessage

func (c *Conn) WriteMessage(m message.Message) error

WriteMessage writes the message as json to the GorillaConnection.

func (*Conn) WritePing

func (c *Conn) WritePing() error

WritePing writes a ping message on the GorillaConnection.

type Upgrader

type Upgrader struct {
	*websocket.Upgrader
}

Upgrader implements the socket.Upgrader interface by wrapping a gorilla/websocket Upgrader.

func NewUpgrader

func NewUpgrader() *Upgrader

NewUpgrader returns a upgrader tha creates gorilla websocket connections.

func (*Upgrader) Upgrade

func (u *Upgrader) Upgrade(w http.ResponseWriter, r *http.Request) (*Conn, error)

Upgrade creates a Conn from the http request.