ws

Documentation

Overview

Package ws contains websocket operations

Index

• func IsUnexpectedCloseError(err error) bool
• type IUpgrader
  • func MakeUpgrader() IUpgrader
• type IWebsocket
  • func Dial(url string) (IWebsocket, error)
• type Upgrader
  • func (upgrader *Upgrader) Upgrade(w http.ResponseWriter, r *http.Request) (IWebsocket, error)

Functions

func IsUnexpectedCloseError

func IsUnexpectedCloseError(err error) bool

IsUnexpectedCloseError returns true if the error is not a normal ws close error

Types

type IUpgrader

type IUpgrader interface {
	Upgrade(w http.ResponseWriter, r *http.Request) (IWebsocket, error)
}

IUpgrader interface to encapsulate the websocket upgrade procedure

func MakeUpgrader

func MakeUpgrader() IUpgrader

MakeUpgrader creates default upgrader

type IWebsocket

type IWebsocket interface {
	SetReadDeadline(t time.Time) error
	SetReadLimit(int64)
	SetPongHandler(h func(appData string) error)

	ReadMessage() ([]byte, error)

	WriteMessage(data []byte) error
	WritePingMessage() error
	WriteCloseMessage() error

	Close() error
}

IWebsocket represents a websocket

func Dial

func Dial(url string) (IWebsocket, error)

Dial open a websocket connection to the given url

type Upgrader

type Upgrader struct {
	// contains filtered or unexported fields
}

Upgrader is the default upgrader

func (*Upgrader) Upgrade

func (upgrader *Upgrader) Upgrade(w http.ResponseWriter, r *http.Request) (IWebsocket, error)

Upgrade upgrades a websocket HTTP request into ws protocol