websocket

Documentation

Overview

Package websocket provides WebSocket connectivity.

Index

• type ServerConn
  • func NewServerConn(w http.ResponseWriter, req *http.Request) (*ServerConn, error)
  • func (c *ServerConn) Close()
  • func (c *ServerConn) ReadJSON(in interface{}) error
  • func (c *ServerConn) RemoteAddr() net.Addr
  • func (c *ServerConn) WriteJSON(in interface{}) error

Types

type ServerConn

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

ServerConn is a server-side WebSocket connection with automatic, periodic ping-pong

func NewServerConn

func NewServerConn(w http.ResponseWriter, req *http.Request) (*ServerConn, error)

NewServerConn allocates a ServerConn.

func (*ServerConn) Close

func (c *ServerConn) Close()

Close closes a ServerConn.

func (*ServerConn) ReadJSON

func (c *ServerConn) ReadJSON(in interface{}) error

ReadJSON reads a JSON object.

func (*ServerConn) RemoteAddr

func (c *ServerConn) RemoteAddr() net.Addr

RemoteAddr returns the remote address.

func (*ServerConn) WriteJSON

func (c *ServerConn) WriteJSON(in interface{}) error

WriteJSON writes a JSON object.