ws

Documentation

Index

• type Client
  • func New(onMessage func([]byte)) *Client
  • func (client *Client) Close() error
  • func (client *Client) Connect(url url.URL, header http.Header) error
  • func (client *Client) Ping(ctx context.Context, cancel context.CancelFunc, ...)
  • func (client *Client) Read(ctx context.Context, cancel context.CancelFunc)
  • func (client *Client) SetHandlers(pingWriteTimeout, pingReadTimeout time.Duration)
  • func (client *Client) Subscribe(handshake map[string]any) error

Types

type Client

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

func New

func New(onMessage func([]byte)) *Client

func (*Client) Close

func (client *Client) Close() error

func (*Client) Connect

func (client *Client) Connect(url url.URL, header http.Header) error

func (*Client) Ping

func (client *Client) Ping(ctx context.Context, cancel context.CancelFunc, pingInterval, pingWriteTimeout time.Duration)

func (*Client) Read

func (client *Client) Read(ctx context.Context, cancel context.CancelFunc)

func (*Client) SetHandlers

func (client *Client) SetHandlers(pingWriteTimeout, pingReadTimeout time.Duration)

Note: this is required to fulfill the websocket protocol.

func (*Client) Subscribe

func (client *Client) Subscribe(handshake map[string]any) error