websocket

Documentation

Index

• Variables
• func Dial[T any](url *url.URL, ctx context.Context) (readerOut <-chan T, writerOut chan<- Write[T], err error)
• func ReadWebsocket[T any](conn io.Reader, writer chan<- []byte) (out T, err error)
• func Serve[T any](r *gin.RouterGroup, path string, acceptFunc func(c *gin.Context) bool, ...)
• func WriteWebsocket[T any](writer chan<- []byte, write Write[T]) error
• type WSHandler
• type Write

Variables

var BufferSize = 10

var ErrNoErrorHandled = errors.New("handled")

var ErrNotImplemented = errors.New("operation not implemented")

Functions

func Dial

func Dial[T any](url *url.URL, ctx context.Context) (readerOut <-chan T, writerOut chan<- Write[T], err error)

func ReadWebsocket

func ReadWebsocket[T any](conn io.Reader, writer chan<- []byte) (out T, err error)

func Serve

func Serve[T any](r *gin.RouterGroup, path string, acceptFunc func(c *gin.Context) bool, wsfunc WSHandler[T])

func WriteWebsocket

func WriteWebsocket[T any](writer chan<- []byte, write Write[T]) error

Types

type WSHandler

type WSHandler[T any] func(<-chan T, chan<- Write[T], gin.Params, context.Context)

type Write

type Write[T any] struct {
	Data T            `json:"data"`
	Err  chan<- error `json:"err"`
}