coder

Sep 7, 2025

Changes in this version

type Config

+ Logger golog.Logger

+ func (c *Config) WithLogger(logger golog.Logger) *Config

Sep 6, 2025

Changes in this version

type Config

+ func DefaultConfig() Config

+ func NewConfig() Config

+ func (c *Config) Clone() Config

+ func (c *Config) WithContext(ctx context.Context) *Config

+ func (c *Config) WithDialOptions(opts *websocket.DialOptions) *Config

+ func (c *Config) WithHeartbeat(heartbeat time.Duration) *Config

+ func (c *Config) WithListening(listening bool) *Config

+ func (c *Config) WithOnClose(callback func()) *Config

+ func (c *Config) WithOnConnect(callback func()) *Config

+ func (c *Config) WithOnError(callback func(error)) *Config

+ func (c *Config) WithOnMessage(callback func(gows.MessageType, []byte)) *Config

+ func (c *Config) WithReadLimit(limit int64) *Config

+ func (c *Config) WithURL(url string) *Config

Jul 15, 2025

Changes in this version

+ var ErrNoOnError = errors.New("gows/coder: OnError callback is not configured")

type Config

+ Listening bool

+ OnError func(error)

Jul 2, 2025

Changes in this version

+ var ErrAlreadyListening = errors.New("gows/coder: websocket client is already listening")

+ var ErrInvalidEventType = errors.New("gows/coder: invalid event type")

+ var ErrNoOnClose = errors.New("gows/coder: OnClose callback is not configured")

+ var ErrNoOnConnect = errors.New("gows/coder: OnConnect callback is not configured")

+ var ErrNoOnMessage = errors.New("gows/coder: OnMessage callback is not configured")

+ var ErrNotListening = errors.New("gows/coder: websocket client is not listening")

type Client

+ func (c *Client) IsListening() bool

+ func (c *Client) On(eventType gows.EventType, callback any) error

+ func (c *Client) StartListening() error

+ func (c *Client) StopListening()

type Config

+ AutoListening bool

+ OnMessage func(gows.MessageType, []byte)

Jun 11, 2025

Changes in this version

+ var ErrAlreadyConnected = errors.New("websocket client is already connected")

+ var ErrNotConnected = errors.New("websocket client is not connected")

+ type Client struct

+ func New(cfg Config) *Client

+ func (c *Client) Close() error

+ func (c *Client) Connect(ctx context.Context) error

+ func (c *Client) HandshakeResponse() *http.Response

+ func (c *Client) Read(ctx context.Context, v any) (gows.MessageType, []byte, error)

+ func (c *Client) Reader(ctx context.Context) (gows.MessageType, io.Reader, error)

+ func (c *Client) Write(ctx context.Context, typ gows.MessageType, p []byte) error

+ func (c *Client) Writer(ctx context.Context, typ gows.MessageType) (io.WriteCloser, error)

+ type Config struct

+ Context context.Context

+ DialOptions *websocket.DialOptions

+ Heartbeat time.Duration

+ OnClose func(ctx context.Context, client gows.Client, err error)

+ OnConnect func(ctx context.Context, client gows.Client, httpResp *http.Response, err error)

+ OnRead func(ctx context.Context, client gows.Client, typ gows.MessageType, p []byte, ...)

+ OnWrite func(ctx context.Context, client gows.Client, typ gows.MessageType, p []byte, ...)

+ ReadLimit int64

+ URL string