zerows

package module

v0.0.3 Latest Latest Go to latest Published: Nov 10, 2023 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/g-luca/zerows

README ¶

zerows

Zero alloc Go Websocket client (using gobwas)

Documentation ¶

Index ¶

Variables
func HandlePayload(conn *net.Conn, length int) ([]byte, error)
func HandlePing(conn *net.Conn) error
func ReadHeader(r io.Reader) (h ws.Header, err error)
func ReadMessage(conn *net.Conn) (payload []byte, err error, connectionClosed bool)
func WriteHeader(w io.Writer, h ws.Header) error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrHeaderLengthMSB        = fmt.Errorf("header error: the most significant bit must be 0")
	ErrHeaderLengthUnexpected = fmt.Errorf("header error: unexpected payloadBuffer length bits")
)

Errors used by frame reader.

Functions ¶

func HandlePayload ¶

func HandlePayload(conn *net.Conn, length int) ([]byte, error)

func HandlePing ¶

func HandlePing(conn *net.Conn) error

HandlePing answers a ping message with a pong message

func ReadHeader ¶

func ReadHeader(r io.Reader) (h ws.Header, err error)

ReadHeader reads a frame header from r.

func ReadMessage ¶ added in v0.0.3

func ReadMessage(conn *net.Conn) (payload []byte, err error, connectionClosed bool)

ReadMessage reads an incoming message

func WriteHeader ¶

func WriteHeader(w io.Writer, h ws.Header) error

WriteHeader writes header binary representation into w.

Types ¶

This section is empty.

Source Files ¶

View all Source files

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