Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

ws

package

Go to main page

Versions in this module

v0

v0.0.2

Jan 4, 2024

Changes in this version

type ClientOption

+ func WithClientTLSConfigFunc(tlsConfigFunc func() *tls.Config) ClientOption

v0.0.1

Jan 2, 2024

Changes in this version

+ const HeaderClientId

+ var ErrConnectionClosed = errors.New("connection closed")

+ type Client struct

+ func NewClient(parent context.Context, urlStr string, handler EventHandler, ...) *Client

+ func (c *Client) GetConn() (*Conn, error)

+ func (c *Client) Start()

+ type ClientOption func(*Client)

+ func WithClientID(clientID string) ClientOption

+ func WithClientLogger(logger *slog.Logger) ClientOption

+ func WithClientTLSConfig(tlsConfig *tls.Config) ClientOption

+ type Codec interface

+ Decode func(data []byte, t T) error

+ Encode func(t T) ([]byte, error)

+ IsBinary func() bool

+ func NewJsonCodec[T proto.Message]() Codec[T]

+ func NewProtoCodec[T proto.Message]() Codec[T]

+ type Conn struct

+ func (c *Conn) Close()

+ func (c *Conn) Notify(ctx context.Context, input []byte) error

+ func (c *Conn) Send(ctx context.Context, input []byte) ([]byte, error)

+ type EventHandler interface

+ HandleNotify func(ctx context.Context, event []byte) error

+ HandleRequest func(ctx context.Context, event []byte) ([]byte, error)

+ type JsonCodec struct

+ func (c JsonCodec[T]) Decode(data []byte, t T) error

+ func (c JsonCodec[T]) Encode(v T) ([]byte, error)

+ func (c JsonCodec[T]) IsBinary() bool

+ type Pool struct

+ func NewPool() *Pool

+ func (m *Pool) GetConn() *Conn

+ func (m *Pool) GetConnByID(id string) *Conn

+ func (m *Pool) GetConnsByID(id string) (result []*Conn)

+ func (m *Pool) Size() int

+ type ProtoCodec struct

+ func (c ProtoCodec[T]) Decode(data []byte, t T) error

+ func (c ProtoCodec[T]) Encode(v T) ([]byte, error)

+ func (c ProtoCodec[T]) IsBinary() bool

+ type ProxyHandler interface

+ ProxyRequest func(conn *Conn, w http.ResponseWriter, r *http.Request) error

+ type Serve struct

+ func NewServe(parent context.Context, handler ProxyHandler, codec Codec[*message.Message], ...) *Serve

+ func (s *Serve) GetConnByID(id string) *Conn

+ func (s *Serve) GetConnsByID(id string) []*Conn

+ func (s *Serve) HandleProxy(w http.ResponseWriter, r *http.Request)

+ func (s *Serve) HandleProxyWithRetry(w http.ResponseWriter, r *http.Request)

+ func (s *Serve) HandleWS(w http.ResponseWriter, r *http.Request)

+ type ServeOption func(*Serve)

+ func WithRequireClientId(b bool) ServeOption

+ func WithServeLogger(logger *slog.Logger) ServeOption