websocket

package

v0.0.0-...-6a24336 Latest Latest Go to latest Published: May 9, 2020 License: MIT Imports: 16 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/dreamans/evnio

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type Conn
- func NewConn(c evnio.Connection, maxPayloadSize int) *Conn
type Handler
type OpCode
type Protocol
- func (p *Protocol) Packet(c evnio.Connection, data []byte) []byte
- func (p *Protocol) UnPacket(c evnio.Connection, buffer *bytes.Buffer) []byte
type Upgrader
- func NewUpgrader(c evnio.Connection) *Upgrader
- func (u *Upgrader) Upgrade(data []byte) error
type Websocket

Constants ¶

View Source

const (
	CloseNormalClosure           = 1000
	CloseGoingAway               = 1001
	CloseProtocolError           = 1002
	CloseUnsupportedData         = 1003
	CloseNoStatusReceived        = 1005
	CloseAbnormalClosure         = 1006
	CloseInvalidFramePayloadData = 1007
	ClosePolicyViolation         = 1008
	CloseMessageTooBig           = 1009
	CloseMandatoryExtension      = 1010
	CloseInternalServerErr       = 1011
	CloseServiceRestart          = 1012
	CloseTryAgainLater           = 1013
)

View Source

const (
	UpgradeContextKey = "upgrade-context"
)

Variables ¶

View Source

var (
	ErrReadLimit      = errors.New("websocket: read limit exceeded")
	ErrBadWriteOpCode = errors.New("websocket: bad write message type")
)

Functions ¶

This section is empty.

Types ¶

type Conn ¶

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

func NewConn ¶

func NewConn(c evnio.Connection, maxPayloadSize int) *Conn

func (*Conn) Close ¶

func (c *Conn) Close() error

func (*Conn) WriteCloseMessage ¶

func (c *Conn) WriteCloseMessage(closeCode int, text string) error

func (*Conn) WriteMessage ¶

func (c *Conn) WriteMessage(opCode OpCode, data []byte) error

func (*Conn) WritePingMessage ¶

func (c *Conn) WritePingMessage(b []byte) error

func (*Conn) WritePongMessage ¶

func (c *Conn) WritePongMessage(b []byte) error

type Handler ¶

type Handler interface {
	OnOpen(*Conn)
	OnMessage(*Conn, OpCode, []byte)
	OnClose(*Conn, int, string)
	OnError(*Conn, error)
	OnPing(*Conn, []byte)
	OnPong(*Conn, []byte)
}

type OpCode ¶

type OpCode byte

const (
	OpContinuation OpCode = 0x0
	OpText         OpCode = 0x1
	OpBinary       OpCode = 0x2
	OpClose        OpCode = 0x8
	OpPing         OpCode = 0x9
	OpPong         OpCode = 0xA
	OpWait         OpCode = 0xFE
	OpNone         OpCode = 0xFF
)

type Protocol ¶

type Protocol struct{}

func (*Protocol) Packet ¶

func (p *Protocol) Packet(c evnio.Connection, data []byte) []byte

func (*Protocol) UnPacket ¶

func (p *Protocol) UnPacket(c evnio.Connection, buffer *bytes.Buffer) []byte

type Upgrader ¶

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

func NewUpgrader ¶

func NewUpgrader(c evnio.Connection) *Upgrader

func (*Upgrader) Upgrade ¶

func (u *Upgrader) Upgrade(data []byte) error

type Websocket ¶

type Websocket struct {
	HandshakeTimeout    time.Duration
	MaxFramePayloadSize int
	CheckOrigin         func() bool
	Handler             Handler
	// contains filtered or unexported fields
}

func (*Websocket) OnClose ¶

func (ws *Websocket) OnClose(c evnio.Connection)

func (*Websocket) OnMessage ¶

func (ws *Websocket) OnMessage(c evnio.Connection, data []byte)

func (*Websocket) OnOpen ¶

func (ws *Websocket) OnOpen(c evnio.Connection)

Source Files ¶

View all Source files

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