websocket

Documentation

Index

• Constants
• Variables
• type Conn
  • func New() *Conn
  • func Upgrade(w http.ResponseWriter, r *http.Request, opt *Options) (*Conn, error)
  • func (c *Conn) C() chan int
  • func (c *Conn) Close() error
  • func (c *Conn) ErrorsChan() chan error
  • func (c *Conn) MessagesChan() chan []byte
  • func (c *Conn) RemoteAddr() net.Addr
  • func (c *Conn) Send(msg []byte) error
• type Options
  • func NewOptions() *Options

Constants

const DefaultReadTimeout = time.Minute

const DefaultWriteTimeout = time.Minute

const MsgTypeBinary = websocket.BinaryMessage

MsgTypeBinary binary message type

const MsgTypeText = websocket.TextMessage

MsgTypeText text message type

Variables

var ErrMsgTypeNotMatch = errors.New("websocket message type not match")

ErrMsgTypeNotMatch error message type not match

var Upgrader = websocket.Upgrader{}

Upgrader websocket connection upgrader config

Types

type Conn

type Conn struct {
	*websocket.Conn
	// contains filtered or unexported fields
}

Conn websocket connection

func New

func New() *Conn

New create new websocket connection. Return connection created.

func Upgrade

func Upgrade(w http.ResponseWriter, r *http.Request, opt *Options) (*Conn, error)

Upgrade Upgrade http requret with given message type to websocket concection. Return websocker connection and any error if raised.

func (*Conn) C

func (c *Conn) C() chan int

C connection close signal chan.

func (*Conn) Close

func (c *Conn) Close() error

Close close connection. Return any error if raised.

func (*Conn) ErrorsChan

func (c *Conn) ErrorsChan() chan error

ErrorsChan connection error chan.

func (*Conn) MessagesChan

func (c *Conn) MessagesChan() chan []byte

MessagesChan connection message chan

func (*Conn) RemoteAddr

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

RemoteAddr return connection rempte address.

func (*Conn) Send

func (c *Conn) Send(msg []byte) error

Send send message to connction. return any error if raised.

type Options

type Options struct {
	ReadTimeout  time.Duration
	WriteTimeout time.Duration
	MsgType      int
}

func NewOptions

func NewOptions() *Options