reconws

Documentation

Index

• type ReconWs
  • func New() *ReconWs
  • func (r *ReconWs) Dial(ctx context.Context, urlStr string) error
  • func (r *ReconWs) Reconnect(ctx context.Context, url string)
  • func (r *ReconWs) ReconnectAuth(ctx context.Context, url, token string)
• type RetryConfig
• type WsMessage

Types

type ReconWs

type ReconWs struct {
	ForwardIncoming bool
	In              chan WsMessage
	Out             chan WsMessage
	Retry           RetryConfig
	Stats           *chanstats.ChanStats
	URL             string
	ID              string
}

ReconWs represents a websocket client that will reconnect if the connection is closed connects (retrying/reconnecting if necessary) to websocket server at url

func New

func New() *ReconWs

New returns a pointer to a new reconnecting websocket client ReconWs

func (*ReconWs) Dial

func (r *ReconWs) Dial(ctx context.Context, urlStr string) error

Dial the websocket server once. If dial fails then return immediately If dial succeeds then handle message traffic until the context is cancelled

func (*ReconWs) Reconnect

func (r *ReconWs) Reconnect(ctx context.Context, url string)

Reconnect sets URL to connect to, and runs the client run this in a separate goroutine so that the connection can be ended from where it was initialised, by close((* ReconWs).Stop)

func (*ReconWs) ReconnectAuth

func (r *ReconWs) ReconnectAuth(ctx context.Context, url, token string)

ReconnectAuth reconnects to a relay instance that uses an access server to gatekeep access to the websocket relay run this in a separate goroutine so that the connection can be ended from where it was initialised, by close((* ReconWs).Stop)

type RetryConfig

type RetryConfig struct {
	Factor  float64
	Jitter  bool
	Min     time.Duration
	Max     time.Duration
	Timeout time.Duration
}

RetryConfig represents the parameters for when to retry to connect

type WsMessage

type WsMessage struct {
	Data []byte
	Type int
	To   string
	From string
}

WsMessage represents a websocket message