README
¶
Resilient WebSocket Client for Go
resilientws is a lightweight and resilient WebSocket client library built in Go, designed for real-time data streaming applications that require automatic reconnection, subscription resumption, and heartbeat management.
Feature
- Connection Management — Establish and maintain a resilient WebSocket connection using the provided configuration (Headers, TLSConfig, Proxy, Logger, PingInterval, PongTimeout, MessageQueueSize).
- Automatic Reconnection — Automatically reconnect to the WebSocket server if the connection is lost, with configurable retry intervals.
- Subscribe Handler — Invoke the SubscribeHandler function after each successful connection or reconnection event.
- Message Handler — Handle incoming messages from the WebSocket server.
- Ping/Pong Mechanism — Send ping messages at the configured PingInterval to keep the connection alive, using the PingHandler function.
- Event Handling — Provide callbacks for connection, reconnection, and error events (onConnected, onReconnecting, onError).
- Message Queue — Maintain a queue of messages to be sent when the connection is reestablished after a disconnection.
Installation
go get github.com/ipanardian/resilientws
Usage
Check the example directory for usage examples.
License
resilientws is licensed under the MIT License.
resilientws inspired by recws
Documentation
¶
Index ¶
- type BackoffType
- type Event
- type EventType
- type Logger
- type Resws
- func (r *Resws) Close()
- func (r *Resws) CloseAndReconnect()
- func (r *Resws) Dial(url string)
- func (r *Resws) GetHTTPResponse() *http.Response
- func (r *Resws) IsConnected() bool
- func (r *Resws) LastConnectTime() time.Time
- func (r *Resws) LastError() error
- func (r *Resws) OnConnected(fn func(url string))
- func (r *Resws) OnError(fn func(err error))
- func (r *Resws) OnReconnecting(fn func(time.Duration))
- func (r *Resws) ReadJSON(v any) (err error)
- func (r *Resws) ReadMessage() (msgType int, msg []byte, err error)
- func (r *Resws) Send(msg []byte) error
- func (r *Resws) SendJSON(v any) (err error)
- func (r *Resws) WriteJSON(v any) (err error)
- func (r *Resws) WriteMessage(msgType int, msg []byte) (err error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BackoffType ¶ added in v0.1.1
type BackoffType int
const ( BackoffTypeJitter BackoffType = iota BackoffTypeFixed )
type Resws ¶
type Resws struct {
// RecBackoffMin is the minimum backoff duration between reconnection attempts
RecBackoffMin time.Duration
// RecBackoffMax is the maximum backoff duration between reconnection attempts
RecBackoffMax time.Duration
// RecBackoffFactor is the factor by which the backoff duration is multiplied
RecBackoffFactor float64
// BackoffType is the type of backoff to use
BackoffType BackoffType
// Handshake timeout
HandshakeTimeout time.Duration
// Headers to be sent with the connection
Headers http.Header
// Ping interval
PingInterval time.Duration
// Pong timeout
PongTimeout time.Duration
// Read deadline
ReadDeadline time.Duration
// Write deadline
WriteDeadline time.Duration
// Message queue size
MessageQueueSize int
// TLS configuration
TLSConfig *tls.Config
// Proxy configuration
Proxy func(*http.Request) (*url.URL, error)
// Logger
Logger Logger
// Non-verbose mode
NonVerbose bool
// Subscribe handler
SubscribeHandler func() error
// Message handler
MessageHandler func(int, []byte)
// Ping handler
PingHandler func()
*websocket.Conn
// contains filtered or unexported fields
}
func (*Resws) CloseAndReconnect ¶
func (r *Resws) CloseAndReconnect()
CloseAndReconnect closes the connection and starts a reconnection attempt
func (*Resws) GetHTTPResponse ¶
GetHTTPResponse returns the HTTP response
func (*Resws) IsConnected ¶
IsConnected returns the connection state
func (*Resws) LastConnectTime ¶
LastConnectTime returns the last connection time
func (*Resws) OnConnected ¶
OnConnected sets the connected handler
func (*Resws) OnReconnecting ¶
OnReconnecting sets the reconnection handler
func (*Resws) ReadMessage ¶
ReadMessage manually reads a message from the websocket connection
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.