wsclient

Documentation

Overview

Package wsclient defines a websocket client and interface

Index

• type Conn
• type Dialer
  • func WrapDialer(d *websocket.Dialer) Dialer
• type Logger
• type Options
• type WSClient
  • func NewWSClient(deps dependencies, options Options) *WSClient
  • func (c *WSClient) Close()
  • func (c *WSClient) Connect(gatewayURL, token string) error
  • func (c *WSClient) HandleRequests(ctx context.Context, handler wsapi.MessageHandler) error
  • func (c *WSClient) SendMessage(msg wsapi.WSMessage)
  • func (c *WSClient) SetDebug(val bool)

Types

type Conn

type Conn interface {
	Close() error
	SetReadDeadline(time.Time) error
	ReadMessage() (int, []byte, error)
	WriteMessage(int, []byte) error
}

Conn is the interface for a *websocket.Conn as used in this wrapper package

type Dialer

type Dialer interface {
	Dial(string, http.Header) (Conn, *http.Response, error)
}

Dialer is the interface for a *websocket.Dialer as used in this wrapper package

func WrapDialer

func WrapDialer(d *websocket.Dialer) Dialer

WrapDialer will wrap a *websocket.Dialer so it conforms to this package's interface

type Logger

type Logger = interface {
	Log(keyvals ...interface{}) error
	Message(string, ...interface{})
	Err(string, error, ...interface{})
	Printf(string, ...interface{})
}

Logger is the interface expected for logging

type Options

type Options struct {
	MaxConcurrentHandlers int
}

Options enables setting up a WSClient with the desired connection settings

type WSClient

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

WSClient is a websocket client. It should be instantiated by NewWSClient

func NewWSClient

func NewWSClient(deps dependencies, options Options) *WSClient

NewWSClient creates a new WSClient

func (*WSClient) Close

func (c *WSClient) Close()

Close closes the client

func (*WSClient) Connect

func (c *WSClient) Connect(gatewayURL, token string) error

Connect creates a connection to the gateway

func (*WSClient) HandleRequests

func (c *WSClient) HandleRequests(ctx context.Context, handler wsapi.MessageHandler) error

HandleRequests starts various goroutines to read and write to the websocket

func (*WSClient) SendMessage

func (c *WSClient) SendMessage(msg wsapi.WSMessage)

SendMessage queues a message to be sent to the websocket

func (*WSClient) SetDebug

func (c *WSClient) SetDebug(val bool)

SetDebug turns on debug mode for the websocket client