ws

package

v0.1.12 Latest Latest Go to latest Published: Feb 9, 2024 License: MIT Imports: 8 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

View Source

const (
	WRITE_TIMEOUT = 1 * time.Second
)

This section is empty.

func Serve[T any](ctx context.Context, socketPath string, protocol Protocol[T], server Server[T]) error

type Client[T any] interface {
	Ctx() context.Context
	P.Pipe[T]
	Close() error
}

func Connect[T any](ctx context.Context, protocol Protocol[T], socketPath string) (Client[T], error)

type Protocol[T any] interface {
	Encode(data T) ([]byte, error)
	Decode(data []byte) (T, error)
}

var RawProtocol Protocol[[]byte] = rawProtocol{}

type RawClient Client[[]byte]

type Server[T any] interface {
	HandleWSClient(client Client[T])
}

type WSClient[T any] struct {
	util.Lifetime
	Conn *websocket.Conn
	// contains filtered or unexported fields
}

func (c *WSClient[T]) Close() error

func (c *WSClient[T]) Receive() <-chan P.Packet[T]

func (c *WSClient[T]) Send(data T) error

type WSServer[T any] struct {
	// contains filtered or unexported fields
}

func (ws *WSServer[T]) ServeHTTP(w http.ResponseWriter, r *http.Request)