apiws

package

v0.0.0-...-72e33f6 Latest Latest Go to latest Published: Mar 13, 2024 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

This section is empty.

View Source

var ErrVisitorEmpty = errors.New("visitor empty")

func Check(visitor Visitor, sig Signal)

func Flush(ctx context.Context, vistor Visitor, writeC chan<- []byte) error

func Logger(conn *websocket.Conn) zerolog.Logger

func Reader(ctx context.Context, conn *websocket.Conn, log zerolog.Logger) <-chan []byte

func Upgrade(w http.ResponseWriter, r *http.Request) (*websocket.Conn, error)

func Writer(ctx context.Context, conn *websocket.Conn, log zerolog.Logger, sig Signal) <-chan chan []byte

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

func NewBufferVisitor(count int) *BufferVisitor

func (v *BufferVisitor) HasMore() bool

func (v *BufferVisitor) Push(data []byte) bool

func (v *BufferVisitor) Visit(ctx context.Context) ([]byte, error)

type OnceVisitor struct {
	Done bool
	// contains filtered or unexported fields
}

func NewOnceVisitor() *OnceVisitor

func (v *OnceVisitor) HasMore() bool

func (v *OnceVisitor) Set(data []byte)

func (v *OnceVisitor) Visit(ctx context.Context) ([]byte, error)

type Signal struct {
	C chan struct{}
}

func NewSignal() Signal

func (s Signal) Queue()

type Visitor interface {
	Visit(ctx context.Context) ([]byte, error)
	HasMore() bool
}

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

func NewVisitors(visitors ...Visitor) Vistors

func (c Vistors) HasMore() bool

func (c Vistors) Visit(ctx context.Context) ([]byte, error)