Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

wsclient

package

Go to main page

Versions in this module

v1

v1.6.7

Oct 6, 2026

v1.6.6

Sep 18, 2026

Changes in this version

+ const WSConfigKeyConnectionCycleInterval

+ const WSConfigKeyConnectionCycleQuiesceTime

+ func NewTestWSServerMulti(testReq func(req *http.Request)) (connections chan *TestWSConnection, url string, rejectNext func(bool), ...)

+ type TestWSConnection struct

+ CloseConn func()

+ Done chan struct{}

+ FromServer chan string

+ ToServer chan string

type WSClient

+ func NewWithConfig(ctx context.Context, config *WSConfig) (WSClient, error)

type WSConfig

+ ConnectionCycleInterval time.Duration

+ ConnectionCycleQuiesceTime time.Duration

+ PostConnectHandler WSPostConnectHandler

+ PreConnectHandler WSPreConnectHandler

+ PreDisconnectHandler WSPreDisconnectHandler

+ type WSPreDisconnectHandler func(ctx context.Context, w WSClient) error

v1.6.5

Jul 22, 2026

v1.6.4

Jul 21, 2026

v1.6.3

Jul 1, 2026

v1.6.2

Jun 29, 2026

v1.6.1

Jun 26, 2026

v1.6.0

Jun 26, 2026

Changes in this version

+ const WSConfigDelayFactor

+ const WSConfigKeyBackgroundConnect

+ const WSConfigKeyConnectionTimeout

+ const WSConfigKeyHeartbeatInterval

+ const WSConfigKeyInitialConnectAttempts

+ const WSConfigKeyPath

+ const WSConfigKeyReadBufferSize

+ const WSConfigKeyWriteBufferSize

+ const WSConfigURL

+ const WSSpecificConfPrefix

+ func GenerateTLSCertficates(t *testing.T) (publicKeyFile *os.File, privateKeyFile *os.File)

+ func InitConfig(conf config.Section)

+ func InitConfigWrap(conf config.Section)

+ func NewTestTLSWSServer(testReq func(req *http.Request), publicKeyFile *os.File, ...) (toServer, fromServer chan string, url string, done func(), err error)

+ func NewTestWSServer(testReq func(req *http.Request)) (toServer, fromServer chan string, url string, done func())

+ type WSClient interface

+ Close func()

+ Connect func() error

+ Receive func() <-chan []byte

+ ReceiveExt func() <-chan *WSPayload

+ Send func(ctx context.Context, message []byte) error

+ SetHeader func(header, value string)

+ SetURL func(url string)

+ URL func() string

+ func New(ctx context.Context, config *WSConfig, beforeConnect WSPreConnectHandler, ...) (WSClient, error)

+ func Wrap(ctx context.Context, config WSWrapConfig, wsconn *websocket.Conn, ...) WSClient

+ type WSConfig struct

+ AuthPassword string

+ AuthUsername string

+ BackgroundConnect bool

+ ConnectionTimeout time.Duration

+ DelayFactor float64

+ DisableReconnect bool

+ HTTPHeaders fftypes.JSONObject

+ HTTPURL string

+ HeartbeatInterval time.Duration

+ InitialConnectAttempts int

+ InitialDelay time.Duration

+ MaximumDelay time.Duration

+ NetDialer *net.Dialer

+ ReadBufferSize int

+ ReceiveExt bool

+ TLSClientConfig *tls.Config

+ ThrottleBurst int

+ ThrottleRequestsPerSecond int

+ WSKeyPath string

+ WebSocketURL string

+ WriteBufferSize int

+ func GenerateConfig(ctx context.Context, conf config.Section) (*WSConfig, error)

+ type WSPayload struct

+ MessageType int

+ Reader io.Reader

+ func NewWSPayload(mt int, r io.Reader) *WSPayload

+ func (wsp *WSPayload) Processed()

+ type WSPostConnectHandler func(ctx context.Context, w WSClient) error

+ type WSPreConnectHandler func(ctx context.Context, w WSClient) error

+ type WSWrapConfig struct

+ HeartbeatInterval time.Duration

+ ReceiveExt bool

+ ThrottleBurst int

+ ThrottleRequestsPerSecond int