wss

Documentation

Index

• Variables
• type Settings
• type WebsocketClient
  • func NewWssClient(sets Settings) *WebsocketClient
  • func (w *WebsocketClient) Close() error
  • func (w *WebsocketClient) Connect(ctx context.Context) error
  • func (w *WebsocketClient) IsConnected() bool
  • func (w *WebsocketClient) ReadJSON(v any) error
  • func (w *WebsocketClient) ReadMessage() (messageType int, p []byte, err error)
  • func (w *WebsocketClient) SendMessage(str string) error
  • func (w *WebsocketClient) SetCloseHandler(handler func(code int, text string) error)

Variables

var (
	// ErrWSAlreadyOpen a websocket that already is open.
	ErrWSAlreadyOpen = errors.New("web socket already opened")

	// ErrWSNotFound is thrown when you attempt to use a websocket
	// that doesn't exist
	ErrWSNotFound = errors.New("no websocket connection exists")
)

Types

type Settings

type Settings struct {
	WssURL  string
	Dialer  *websocket.Dialer
	Headers http.Header
}

type WebsocketClient

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

func NewWssClient

func NewWssClient(sets Settings) *WebsocketClient

func (*WebsocketClient) Close

func (w *WebsocketClient) Close() error

func (*WebsocketClient) Connect

func (w *WebsocketClient) Connect(ctx context.Context) error

func (*WebsocketClient) IsConnected

func (w *WebsocketClient) IsConnected() bool

func (*WebsocketClient) ReadJSON

func (w *WebsocketClient) ReadJSON(v any) error

func (*WebsocketClient) ReadMessage

func (w *WebsocketClient) ReadMessage() (messageType int, p []byte, err error)

func (*WebsocketClient) SendMessage

func (w *WebsocketClient) SendMessage(str string) error

func (*WebsocketClient) SetCloseHandler

func (w *WebsocketClient) SetCloseHandler(handler func(code int, text string) error)