gowebsockethub

package module

v0.0.0-...-cb05811 Latest Latest Go to latest Published: Feb 25, 2024 License: MIT Imports: 5 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.

This section is empty.

func Handle(route Route, handler Handler)

func Intercept(route Route, interceptor Handler)

func SetMessageParser(p MessageParser)

type Handler func(ctx context.Context, message Message, writing chan<- Message) error

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

func New(conn *websocket.Conn, readingCapacity uint32, writingCapacity uint32) (hub *Hub, writing chan Message, errs chan error)

func (hub *Hub) Handle(route Route, handler Handler)

func (hub *Hub) Intercept(route Route, interceptor Handler)

func (hub *Hub) Run(ctx context.Context)

func (hub *Hub) SetMaxMessageSize(size int64)

func (hub *Hub) SetMessageParser(p MessageParser)

func (hub *Hub) SetPingPeriod(period time.Duration)

func (hub *Hub) SetReadWait(wait time.Duration)

func (hub *Hub) SetWriteWait(wait time.Duration)

type Message interface {
	GetID() string
	GetRoute() Route
	GetPayload() string
}

type MessageParser func(ctx context.Context, raw []byte) (Message, error)

type Route string