websocket

package

v0.5.1 Latest Latest Go to latest Published: Oct 24, 2019 License: MIT Imports: 4 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

This section is empty.

View Source

var (
	Upgrader = websocket.Upgrader{ReadBufferSize: 1024, WriteBufferSize: 1024}
)

This section is empty.

type Breaker interface {
	Register(conn *websocket.Conn) error
	UnRegister(client *Client) error
	BroadCast(msg Message) error
}

func NewBreaker(opts ...Option) (Breaker, error)

Create Breaker

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

It is a client between a server and a client

func NewClient(bk *breaker, conn *websocket.Conn) (*Client, error)

type ErrorHandler func(error)

It is executed if error is raised

type Message interface {
	GetMessage() []byte
}

It is interface on message.

type Option interface {
	// contains filtered or unexported methods
}

type OptionFunc func(bk *breaker)

func WithErrorHandlerOption(f ErrorHandler) OptionFunc

func WithMaxMessagePoolLength(length int64) OptionFunc

func WithMaxReadLimit(length int64) OptionFunc