websocket

package module

Go to main page

Versions in this module

v1

v1.0.4

Feb 3, 2021

v1.0.3

Dec 14, 2020

Changes in this version

+ func JoinMessages(c *Conn, term string) io.Reader

+ type BufferPool interface

+ Get func() interface{}

+ Put func(interface{})

type Conn

+ func (c *Conn) SetCompressionLevel(level int) error

+ func (c *Conn) WritePreparedMessage(pm *PreparedMessage) error

type Dialer

+ NetDialContext func(ctx context.Context, network, addr string) (net.Conn, error)

+ WriteBufferPool BufferPool

+ func (d *Dialer) DialContext(ctx context.Context, urlStr string, requestHeader http.Header) (*Conn, *http.Response, error)

type EchoUpgrader

+ WriteBufferPool BufferPool

+ type PreparedMessage struct

+ func NewPreparedMessage(messageType int, data []byte) (*PreparedMessage, error)

type Upgrader

+ WriteBufferPool BufferPool

v1.0.2

Oct 23, 2020

v1.0.1

Dec 5, 2016

Changes in this version

+ func EchoIsWebSocketUpgrade(r engine.Request) bool

+ func EchoSubprotocols(r engine.Request) []string

+ func EchoUpgrade(ctx echo.Context, handler func(*Conn) error, responseHeader http.Header, ...) error

type Conn

+ func (c *Conn) CloseHandler() func(code int, text string) error

+ func (c *Conn) EnableWriteCompression(enable bool)

+ func (c *Conn) PingHandler() func(appData string) error

+ func (c *Conn) PongHandler() func(appData string) error

+ func (c *Conn) SetCloseHandler(h func(code int, text string) error)

type Dialer

+ EnableCompression bool

+ Jar http.CookieJar

+ type EchoUpgrader struct

+ CheckOrigin func(r engine.Request) bool

+ EnableCompression bool

+ Error func(ctx echo.Context, status int, reason error)

+ Handler func(*Conn) error

+ HandshakeTimeout time.Duration

+ ReadBufferSize int

+ Subprotocols []string

+ WriteBufferSize int

+ func (u *EchoUpgrader) Upgrade(ctx echo.Context, handler func(*Conn) error, responseHeader http.Header) error

type Upgrader

+ EnableCompression bool

v1.0.0

Apr 28, 2016

Changes in this version

+ const BinaryMessage

+ const CloseAbnormalClosure

+ const CloseGoingAway

+ const CloseInternalServerErr

+ const CloseInvalidFramePayloadData

+ const CloseMandatoryExtension

+ const CloseMessage

+ const CloseMessageTooBig

+ const CloseNoStatusReceived

+ const CloseNormalClosure

+ const ClosePolicyViolation

+ const CloseProtocolError

+ const CloseServiceRestart

+ const CloseTLSHandshake

+ const CloseTryAgainLater

+ const CloseUnsupportedData

+ const PingMessage

+ const PongMessage

+ const TextMessage

+ var DefaultDialer = &Dialer

+ var ErrBadHandshake = errors.New("websocket: bad handshake")

+ var ErrCloseSent = errors.New("websocket: close sent")

+ var ErrReadLimit = errors.New("websocket: read limit exceeded")

+ func FormatCloseMessage(closeCode int, text string) []byte

+ func IsCloseError(err error, codes ...int) bool

+ func IsUnexpectedCloseError(err error, expectedCodes ...int) bool

+ func IsWebSocketUpgrade(r *http.Request) bool

+ func ReadJSON(c *Conn, v interface{}) error

+ func Subprotocols(r *http.Request) []string

+ func WriteJSON(c *Conn, v interface{}) error

+ type CloseError struct

+ Code int

+ Text string

+ func (e *CloseError) Error() string

+ type Conn struct

+ func NewClient(netConn net.Conn, u *url.URL, requestHeader http.Header, ...) (c *Conn, response *http.Response, err error)

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

+ func (c *Conn) Close() error

+ func (c *Conn) LocalAddr() net.Addr

+ func (c *Conn) NextReader() (messageType int, r io.Reader, err error)

+ func (c *Conn) NextWriter(messageType int) (io.WriteCloser, error)

+ func (c *Conn) ReadJSON(v interface{}) error

+ func (c *Conn) ReadMessage() (messageType int, p []byte, err error)

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

+ func (c *Conn) SetPingHandler(h func(appData string) error)

+ func (c *Conn) SetPongHandler(h func(appData string) error)

+ func (c *Conn) SetReadDeadline(t time.Time) error

+ func (c *Conn) SetReadLimit(limit int64)

+ func (c *Conn) SetWriteDeadline(t time.Time) error

+ func (c *Conn) Subprotocol() string

+ func (c *Conn) UnderlyingConn() net.Conn

+ func (c *Conn) WriteControl(messageType int, data []byte, deadline time.Time) error

+ func (c *Conn) WriteJSON(v interface{}) error

+ func (c *Conn) WriteMessage(messageType int, data []byte) error

+ type Dialer struct

+ HandshakeTimeout time.Duration

+ NetDial func(network, addr string) (net.Conn, error)

+ Proxy func(*http.Request) (*url.URL, error)

+ ReadBufferSize int

+ Subprotocols []string

+ TLSClientConfig *tls.Config

+ WriteBufferSize int

+ func (d *Dialer) Dial(urlStr string, requestHeader http.Header) (*Conn, *http.Response, error)

+ type HandshakeError struct

+ func (e HandshakeError) Error() string

+ type Upgrader struct

+ CheckOrigin func(r *http.Request) bool

+ Error func(w http.ResponseWriter, r *http.Request, status int, reason error)

+ HandshakeTimeout time.Duration

+ ReadBufferSize int

+ Subprotocols []string

+ WriteBufferSize int

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

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL