websocket

Documentation

Index

• Variables
• type Client
  • func (c *Client) Connect(address url.URL) (*Connection, error)
• type Connection
  • func (c *Connection) Close()
  • func (c *Connection) IsServer() bool
  • func (c *Connection) Listen() chan struct{}
  • func (c *Connection) SetMessageHandler(fn MessageHandler)
  • func (c *Connection) Write(data []byte)
• type MessageHandler
• type Server
  • func (s *Server) Connect(w http.ResponseWriter, r *http.Request, responseHeader http.Header) (*Connection, error)
• type Upgrader
  • func NewUpgrader(origin string) *Upgrader
  • func (u *Upgrader) Upgrade(w http.ResponseWriter, r *http.Request, responseHeader http.Header) (*websocket.Conn, error)

Variables

var DefaultDialer = websocket.DefaultDialer

var DefaultUpgrader = Upgrader{Upgrader: websocket.Upgrader{
	ReadBufferSize:    2048,
	WriteBufferSize:   2048,
	WriteBufferPool:   &sync.Pool{},
	EnableCompression: true,
}}

Types

type Client

type Client struct {
	Dialer *websocket.Dialer
}

func (*Client) Connect

func (c *Client) Connect(address url.URL) (*Connection, error)

type Connection

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

func (*Connection) Close

func (c *Connection) Close()

func (*Connection) IsServer

func (c *Connection) IsServer() bool

IsServer returns true if the connection has server capabilities and not just a client. For now, we assume every connection with ping/pong handler is a server.

func (*Connection) Listen

func (c *Connection) Listen() chan struct{}

func (*Connection) SetMessageHandler

func (c *Connection) SetMessageHandler(fn MessageHandler)

func (*Connection) Write

func (c *Connection) Write(data []byte)

type MessageHandler

type MessageHandler func([]byte, error)

type Server

type Server struct {
	Upgrader *Upgrader
}

func (*Server) Connect

func (s *Server) Connect(w http.ResponseWriter, r *http.Request, responseHeader http.Header) (*Connection, error)

type Upgrader

type Upgrader struct {
	websocket.Upgrader
	Origin string
}

func NewUpgrader

func NewUpgrader(origin string) *Upgrader

func (*Upgrader) Upgrade

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