websocket

Documentation

Index

• type Conn
  • func Dial(ctx context.Context, url string, opts ...DialOption) (*Conn, error)
  • func New(wsConn *websocket.Conn) *Conn
  • func (c *Conn) Close() error
  • func (c *Conn) LocalAddr() net.Addr
  • func (c *Conn) Read(b []byte) (int, error)
  • func (c *Conn) RemoteAddr() net.Addr
  • func (c *Conn) SetDeadline(t time.Time) error
  • func (c *Conn) SetReadDeadline(t time.Time) error
  • func (c *Conn) SetWriteDeadline(t time.Time) error
  • func (c *Conn) Write(b []byte) (int, error)
• type DialOption
  • func WithTLSConfig(config *tls.Config) DialOption
  • func WithToken(token string) DialOption
• type RetryableError
  • func NewRetryableError(err error) *RetryableError
  • func (e *RetryableError) Error() string
  • func (e *RetryableError) Unwrap() error

Types

type Conn

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

Conn implements a net.Conn using WebSockets as the underlying transport.

This adds a small amount of overhead compared to using TCP directly, though it means the connection can be used with HTTP servers and load balancers.

func Dial

func Dial(ctx context.Context, url string, opts ...DialOption) (*Conn, error)

func New

func New(wsConn *websocket.Conn) *Conn

func (*Conn) Close

func (c *Conn) Close() error

func (*Conn) LocalAddr

func (c *Conn) LocalAddr() net.Addr

func (*Conn) Read

func (c *Conn) Read(b []byte) (int, error)

func (*Conn) RemoteAddr

func (c *Conn) RemoteAddr() net.Addr

func (*Conn) SetDeadline

func (c *Conn) SetDeadline(t time.Time) error

func (*Conn) SetReadDeadline

func (c *Conn) SetReadDeadline(t time.Time) error

func (*Conn) SetWriteDeadline

func (c *Conn) SetWriteDeadline(t time.Time) error

func (*Conn) Write

func (c *Conn) Write(b []byte) (int, error)

type DialOption

type DialOption interface {
	// contains filtered or unexported methods
}

func WithTLSConfig

func WithTLSConfig(config *tls.Config) DialOption

func WithToken

func WithToken(token string) DialOption

type RetryableError

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

RetryableError indicates a error is retryable.

func NewRetryableError

func NewRetryableError(err error) *RetryableError

func (*RetryableError) Error

func (e *RetryableError) Error() string

func (*RetryableError) Unwrap

func (e *RetryableError) Unwrap() error