feat: add data retrieval close function

go.mod

@@ -3,3 +3,7 @@ module git.neurocipta.com/rogerferdinan/safe-web-socket
 go 1.24.5
 
 require github.com/gorilla/websocket v1.5.3
+
+require git.neurocipta.com/rogerferdinan/custom-rwmutex v1.0.0
+
+require git.neurocipta.com/rogerferdinan/safe-map v0.0.0-20251011004629-ab0b119a7c48 // indirect

go.sum

@@ -1,2 +1,6 @@
+git.neurocipta.com/rogerferdinan/custom-rwmutex v1.0.0 h1:KnNc40SrYsg0cksIIcQy/ca6bunkGADQOs1u7O/E+iY=
+git.neurocipta.com/rogerferdinan/custom-rwmutex v1.0.0/go.mod h1:9DvvHc2UZhBwEs63NgO4IhiuHnBNtTuBkTJgiMnnCss=
+git.neurocipta.com/rogerferdinan/safe-map v0.0.0-20251011004629-ab0b119a7c48 h1:4wXSbEuwFd2gycaaGP35bjUkKEEO6WcVfJ6cetEyT5s=
+git.neurocipta.com/rogerferdinan/safe-map v0.0.0-20251011004629-ab0b119a7c48/go.mod h1:QtIxG0BYCCq8a5qyklpSHA8qWUvKr+mfl42qF9QxTc0=
 github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg=
 github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=

internal/hub.go

@@ -1,7 +1,6 @@
 package internal
 
 import (
-	"fmt"
 	"log"
 	"time"
 
@@ -11,7 +10,7 @@ import (
 const (
 	writeWait  = 10 * time.Second
 	pongWait   = 60 * time.Second
-	pingPeriod = 55 * time.Second
+	pingPeriod = 25 * time.Second
 )
 
 type Client struct {
@@ -19,16 +18,14 @@ type Client struct {
 	Send           chan []byte
 	SubscribedPath string
 	done           chan struct{}
-	mu             *CustomRwMutex
 }
 
 func NewClient(conn *websocket.Conn, subscribedPath string) *Client {
 	return &Client{
 		Conn:           conn,
-		Send:           make(chan []byte, 64),
+		Send:           make(chan []byte, 2),
 		SubscribedPath: subscribedPath,
-		done:           make(chan struct{}),
-		mu:             NewCustomRwMutex(),
+		done:           make(chan struct{}, 1),
 	}
 }
 
@@ -37,17 +34,14 @@ type Hub struct {
 	Broadcast  chan []byte
 	Register   chan *Client
 	Unregister chan *Client
-	writeMu    *CustomRwMutex
-	readMu     *CustomRwMutex
 }
 
 func NewHub() *Hub {
 	return &Hub{
-		Broadcast:  make(chan []byte),
-		Register:   make(chan *Client),
-		Unregister: make(chan *Client),
-		Clients:    make(map[*Client]bool),
-		writeMu:    NewCustomRwMutex(),
+		Broadcast:  make(chan []byte, 1),
+		Register:   make(chan *Client, 1),
+		Unregister: make(chan *Client, 1),
+		Clients:    make(map[*Client]bool, 0),
 	}
 }
 
@@ -100,7 +94,7 @@ func WritePump(c *Client, h *Hub) {
 			}
 		case <-pingTicker.C:
 			c.Conn.SetWriteDeadline(time.Now().Add(writeWait))
-			if err := c.Conn.WriteMessage(websocket.PingMessage, nil); err != nil {
+			if err := c.Conn.WriteMessage(websocket.PingMessage, []byte{}); err != nil {
 				return
 			}
 		}
@@ -123,14 +117,14 @@ func ReadPump(c *Client, h *Hub) {
 	for {
 		messageType, message, err := c.Conn.ReadMessage()
 		if err != nil {
-			if !websocket.IsUnexpectedCloseError(err, websocket.CloseGoingAway, websocket.CloseAbnormalClosure) {
+			if websocket.IsUnexpectedCloseError(err, websocket.CloseGoingAway, websocket.CloseAbnormalClosure) {
 				log.Printf("WebSocket error: %v", err)
 			}
 			break
 		}
 
 		if messageType == websocket.TextMessage {
-			fmt.Printf("Received: %s\n", message)
+			log.Printf("Received: %s\n", message)
 		}
 	}
 }

internal/mutex.go

@@ -1,33 +0,0 @@
-package internal
-
-import (
-	"sync"
-)
-
-type CustomRwMutex struct {
-	mu *sync.RWMutex
-}
-
-func NewCustomRwMutex() *CustomRwMutex {
-	return &CustomRwMutex{
-		mu: &sync.RWMutex{},
-	}
-}
-
-func (rwMu *CustomRwMutex) WriteHandler(fn func() error) error {
-	rwMu.mu.Lock()
-	defer rwMu.mu.Unlock()
-	if err := fn(); err != nil {
-		return err
-	}
-	return nil
-}
-
-func (rwMu *CustomRwMutex) ReadHandler(fn func() error) error {
-	rwMu.mu.RLock()
-	defer rwMu.mu.RUnlock()
-	if err := fn(); err != nil {
-		return err
-	}
-	return nil
-}

v1/client/client.go

@@ -5,21 +5,42 @@ import (
 	"fmt"
 	"log"
 	"net/url"
+	"strings"
 	"time"
 
+	custom_rwmutex "git.neurocipta.com/rogerferdinan/custom-rwmutex"
+	safemap "git.neurocipta.com/rogerferdinan/safe-map"
 	"git.neurocipta.com/rogerferdinan/safe-web-socket/internal"
 	"github.com/gorilla/websocket"
 )
 
 const (
 	pingPeriod   = 10 * time.Second
+	readDeadline = 30 * time.Second
 )
 
+type MessageType uint
+
+const (
+	MessageTypeText  MessageType = websocket.TextMessage
+	MessageTypePing  MessageType = websocket.PingMessage
+	MessageTypePong  MessageType = websocket.PongMessage
+	MessageTypeClose MessageType = websocket.CloseMessage
+)
+
+type Message struct {
+	MessageType MessageType
+	Data        []byte
+}
+
 type SafeWebsocketClientBuilder struct {
 	baseHost    *string `nil_checker:"required"`
 	basePort    *uint16 `nil_checker:"required"`
-	path     *string `nil_checkeer:"required"`
+	path        *string
+	rawQuery    *string
+	isDrop      *bool
 	useTLS      *bool
+	channelSize *int64
 }
 
 func NewSafeWebsocketClientBuilder() *SafeWebsocketClientBuilder {
@@ -46,33 +67,61 @@ func (b *SafeWebsocketClientBuilder) Path(path string) *SafeWebsocketClientBuild
 	return b
 }
 
-func (b *SafeWebsocketClientBuilder) Build() (*SafeWebsocketClient, error) {
+func (b *SafeWebsocketClientBuilder) RawQuery(rawQuery string) *SafeWebsocketClientBuilder {
+	b.rawQuery = &rawQuery
+	return b
+}
+
+func (b *SafeWebsocketClientBuilder) IsDrop(isDrop bool) *SafeWebsocketClientBuilder {
+	b.isDrop = &isDrop
+	return b
+}
+
+func (b *SafeWebsocketClientBuilder) ChannelSize(channelSize int64) *SafeWebsocketClientBuilder {
+	b.channelSize = &channelSize
+	return b
+}
+
+func (b *SafeWebsocketClientBuilder) Build(ctx context.Context) (*SafeWebsocketClient, error) {
 	if err := internal.NilChecker(b); err != nil {
 		return nil, err
 	}
 
-	ctx, cancel := context.WithCancel(context.Background())
+	// var useTLS bool
+	if b.useTLS == nil {
+		useTLS := true
+		b.useTLS = &useTLS
+	}
 
-	var useTLS bool
-	if b.useTLS != nil {
-		useTLS = *b.useTLS
+	if b.isDrop == nil {
+		isDrop := true
+		b.isDrop = &isDrop
+	}
+
+	if b.channelSize == nil {
+		channelSize := int64(1)
+		b.channelSize = &channelSize
 	}
 
 	wsClient := SafeWebsocketClient{
 		baseHost:    *b.baseHost,
 		basePort:    *b.basePort,
-		useTLS:      useTLS,
-		path:        *b.path,
+		useTLS:      *b.useTLS,
+		isDrop:      *b.isDrop,
+		path:        b.path,
+		rawQuery:    b.rawQuery,
+		dataChannel: make(chan []byte, *b.channelSize),
+		mu:          custom_rwmutex.NewCustomRwMutex(),
 		ctx:         ctx,
-		cancel:      cancel,
-		dataChannel: make(chan []byte, 1),
-		mu:          internal.NewCustomRwMutex(),
 		reconnectCh: make(chan struct{}, 1),
 		isConnected: false,
+		doneMap:     safemap.NewSafeMap[string, chan struct{}](),
+		writeChan:   make(chan Message, 1),
 	}
 
+	go wsClient.reconnectHandler()
+
 	if err := wsClient.connect(); err != nil {
-		cancel()
 		return nil, fmt.Errorf("failed to establish initial connection: %v", err)
 	}
 
@@ -82,15 +131,24 @@ func (b *SafeWebsocketClientBuilder) Build() (*SafeWebsocketClient, error) {
 type SafeWebsocketClient struct {
 	baseHost string
 	basePort uint16
+	isDrop   bool
 	useTLS   bool
-	path        string
-	dataChannel chan []byte
-	mu          *internal.CustomRwMutex
+	path     *string
+	rawQuery *string
+
+	mu          *custom_rwmutex.CustomRwMutex
 	conn        *websocket.Conn
 	ctx         context.Context
-	cancel      context.CancelFunc
+	cancelFuncs []context.CancelFunc
+	dataChannel chan []byte
+
 	reconnectCh    chan struct{}
+	reconnectChans []chan struct{}
 	isConnected    bool
+	doneMap        *safemap.SafeMap[string, chan struct{}]
+
+	writeChan chan Message
+	pongChan  chan error
 }
 
 func (wsClient *SafeWebsocketClient) connect() error {
@@ -103,84 +161,190 @@ func (wsClient *SafeWebsocketClient) connect() error {
 	newURL := url.URL{
 		Scheme: scheme,
 		Host:   fmt.Sprintf("%s:%d", wsClient.baseHost, wsClient.basePort),
-		Path:   wsClient.path,
 	}
+
+	if wsClient.path != nil && strings.TrimSpace(*wsClient.path) != "" {
+		newURL.Path = *wsClient.path
+	}
+
+	if wsClient.rawQuery != nil && strings.TrimSpace(*wsClient.rawQuery) != "" {
+		newURL.RawQuery = *wsClient.rawQuery
+	}
+
 	conn, _, err := websocket.DefaultDialer.Dial(newURL.String(), nil)
 	if err != nil {
 		return fmt.Errorf("failed to connect to %s: %w", wsClient.baseHost, err)
 	}
 
-	conn.SetPingHandler(func(pingData string) error {
-		if err := conn.WriteMessage(websocket.PongMessage, []byte(pingData)); err != nil {
-			if err == websocket.ErrCloseSent {
-				return nil
-			}
-			if netErr, ok := err.(interface{ Timeout() bool }); ok && netErr.Timeout() {
-				return nil
-			}
-			return err
-		}
+	pingCtx, pingCancel := context.WithCancel(context.Background())
+	wsClient.mu.WriteHandler(func() error {
+		wsClient.cancelFuncs = append(wsClient.cancelFuncs, pingCancel)
 		return nil
 	})
 
-	wsClient.mu.WriteHandler(func() error {
+	go wsClient.startPingTicker(pingCtx)
+
+	if wsClient.conn != nil {
+		wsClient.conn.Close()
+	}
 	wsClient.conn = conn
 	wsClient.isConnected = true
+
+	go wsClient.writePump()
+	go wsClient.readPump()
+
+	conn.SetPingHandler(func(pingData string) error {
+		wsClient.writeChan <- Message{
+			MessageType: MessageTypePong,
+			Data:        []byte(pingData),
+		}
+
+		select {
+		case err := <-wsClient.pongChan:
+			return err
+		default:
+		}
 		return nil
 	})
 
-	go wsClient.startPingTicker()
-	go wsClient.startReceiveHandler()
-	go wsClient.reconnectHandler()
-
 	return nil
 }
 
-func (wsClient *SafeWebsocketClient) startPingTicker() {
-	ticker := time.NewTicker(pingPeriod)
-	defer ticker.Stop()
-	for {
-		select {
-		case <-ticker.C:
+func (wsClient *SafeWebsocketClient) writePump() {
+	ctx, cancel := context.WithCancel(context.Background())
 	wsClient.mu.WriteHandler(func() error {
-				if err := wsClient.conn.WriteMessage(websocket.PingMessage, []byte{}); err != nil {
-					log.Printf("Ping failed: %v. Will attempt reconnect.", err)
-					wsClient.triggerReconnect()
-				}
+		wsClient.cancelFuncs = append(wsClient.cancelFuncs, cancel)
 		return nil
 	})
-		case <-wsClient.ctx.Done():
-			log.Println("Ping ticker stopped")
+
+	var c *websocket.Conn
+	wsClient.mu.ReadHandler(func() error {
+		c = wsClient.conn
+		return nil
+	})
+
+	for {
+		select {
+		case <-ctx.Done():
+			log.Println("Writer canceled by context")
+			return
+		case data := <-wsClient.writeChan:
+			if c == nil {
+				return
+			}
+
+			if err := c.WriteMessage(int(data.MessageType), data.Data); err != nil {
+				log.Printf("error on write message: %v\n", err)
+				if data.MessageType == MessageTypePong {
+					wsClient.pongChan <- err
+				}
 				return
 			}
 		}
+	}
 }
 
-func (wsClient *SafeWebsocketClient) startReceiveHandler() {
+func (wsClient *SafeWebsocketClient) readPump() {
+	ctx, cancel := context.WithCancel(context.Background())
+	wsClient.mu.WriteHandler(func() error {
+		wsClient.cancelFuncs = append(wsClient.cancelFuncs, cancel)
+		return nil
+	})
+
+	var c *websocket.Conn
+	wsClient.mu.ReadHandler(func() error {
+		c = wsClient.conn
+		return nil
+	})
+
+	if wsClient.isDrop {
 		for {
 			select {
-		case <-wsClient.reconnectCh:
-		case <-wsClient.ctx.Done():
-			log.Println("Reconnect handler stopped")
+			case <-ctx.Done():
+				log.Println("Reader canceled by context")
 				return
 			default:
-			if err := wsClient.mu.WriteHandler(func() error {
-				conn := wsClient.conn
+				if c == nil {
+					return
+				}
 
-				if conn == nil {
-					return fmt.Errorf("no active connection, waiting for reconnect")
+				if err := c.SetReadDeadline(time.Now().Add(readDeadline)); err != nil {
+					log.Printf("error on read deadline: %v\n", err)
+					return
 				}
-				_, message, err := conn.ReadMessage()
+
+				messageType, data, err := c.ReadMessage()
 				if err != nil {
-					return err
-				}
-				fmt.Println(string(message))
-				wsClient.dataChannel <- message
-				return nil
-			}); err != nil {
+					log.Printf("error on read message: %v\n", err)
 					wsClient.triggerReconnect()
 					return
 				}
+
+				if messageType != websocket.TextMessage {
+					continue
+				}
+
+				select {
+				case wsClient.dataChannel <- data:
+				case <-ctx.Done():
+					return
+				default:
+					log.Println("Data channel full, dropping message")
+				}
+			}
+		}
+	} else {
+		for {
+			select {
+			case <-ctx.Done():
+				log.Println("Reader canceled by context")
+				return
+			default:
+				if c == nil {
+					return
+				}
+
+				if err := c.SetReadDeadline(time.Now().Add(readDeadline)); err != nil {
+					log.Printf("error on read deadline: %v\n", err)
+					return
+				}
+
+				messageType, data, err := c.ReadMessage()
+				if err != nil {
+					log.Printf("error on read message: %v\n", err)
+					wsClient.triggerReconnect()
+					return
+				}
+
+				if messageType != websocket.TextMessage {
+					continue
+				}
+
+				select {
+				case wsClient.dataChannel <- data:
+				case <-ctx.Done():
+					return
+				}
+			}
+		}
+	}
+
+}
+
+func (wsClient *SafeWebsocketClient) startPingTicker(ctx context.Context) {
+	ticker := time.NewTicker(pingPeriod)
+	defer ticker.Stop()
+
+	for {
+		select {
+		case <-ctx.Done():
+			log.Println("ping ticker canceled by context")
+			return
+		case <-ticker.C:
+			wsClient.writeChan <- Message{
+				MessageType: websocket.PingMessage,
+				Data:        []byte{},
+			}
 		}
 	}
 }
@@ -193,11 +357,106 @@ func (wsClient *SafeWebsocketClient) triggerReconnect() {
 }
 
 func (wsClient *SafeWebsocketClient) reconnectHandler() {
-	for range wsClient.reconnectCh {
-		wsClient.connect()
+	backoff := 1 * time.Second
+	maxBackoff := 30 * time.Second
+	for {
+		select {
+		case <-wsClient.reconnectCh:
+			log.Println("Reconnect triggered")
+
+			wsClient.mu.ReadHandler(func() error {
+				if wsClient.cancelFuncs != nil {
+					for _, cancel := range wsClient.cancelFuncs {
+						cancel()
 					}
+				}
+				return nil
+			})
+
+			wsClient.isConnected = false
+			// time.Sleep(100 * time.Millisecond)
+
+			isInnerLoop := true
+			for isInnerLoop {
+				log.Printf("Attempting reconnect in %v...", backoff)
+				select {
+				case <-time.After(backoff):
+					if err := wsClient.connect(); err != nil {
+						log.Printf("Reconnect failed: %v", err)
+						if backoff < maxBackoff {
+							backoff *= 2
+						}
+						continue
+					}
+					log.Println("Reconnected successfully")
+					backoff = 1 * time.Second
+					isInnerLoop = false
+					continue
+				case <-wsClient.ctx.Done():
+					log.Println("reconnect handler stopped due to client shutdown")
+					wsClient.Close()
+					return
+				}
+			}
+			if wsClient.reconnectChans != nil {
+				for _, reconnectCh := range wsClient.reconnectChans {
+					reconnectCh <- struct{}{}
+				}
+			}
+		case <-wsClient.ctx.Done():
+			log.Println("reconnect handler stopped due to client shutdown")
+			wsClient.Close()
+			return
+		}
+	}
+}
+
+func (wsClient *SafeWebsocketClient) ReconnectChannel() <-chan struct{} {
+	reconnectCh := make(chan struct{}, 1)
+	wsClient.mu.WriteHandler(func() error {
+		wsClient.reconnectChans = append(wsClient.reconnectChans, reconnectCh)
+		return nil
+	})
+
+	return reconnectCh
 }
 
 func (wsClient *SafeWebsocketClient) DataChannel() <-chan []byte {
 	return wsClient.dataChannel
 }
+
+func (wsClient *SafeWebsocketClient) CloseDataChannel() {
+	close(wsClient.dataChannel)
+}
+
+func (wsClient *SafeWebsocketClient) Write(data []byte) error {
+	wsClient.writeChan <- Message{
+		MessageType: MessageTypeText,
+		Data:        data,
+	}
+	return nil
+}
+
+func (wsClient *SafeWebsocketClient) Close() error {
+	wsClient.mu.ReadHandler(func() error {
+		if wsClient.cancelFuncs != nil {
+			for _, cancel := range wsClient.cancelFuncs {
+				cancel()
+			}
+		}
+		return nil
+	})
+
+	if wsClient.reconnectChans != nil {
+		for _, reconnectChan := range wsClient.reconnectChans {
+			close(reconnectChan)
+		}
+	}
+	if wsClient.conn != nil {
+		wsClient.conn.Close()
+	}
+	wsClient.isConnected = false
+	// close(wsClient.dataChannel)
+
+	return nil
+}

v1/examples/client/main.go

@@ -1,25 +1,50 @@
 package main
 
 import (
+	"context"
 	"fmt"
 	"log"
+	"os"
+	"os/signal"
+	"syscall"
 
 	"git.neurocipta.com/rogerferdinan/safe-web-socket/v1/client"
 )
 
 func main() {
+	sigChan := make(chan os.Signal, 1)
+	signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM)
+
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
+
+	go func() {
+		<-sigChan
+		fmt.Println("\nReceived interrupt signal. Shutting down gracefully...")
+		cancel()
+	}()
+
 	wsClient, err := client.NewSafeWebsocketClientBuilder().
 		BaseHost("localhost").
 		BasePort(8080).
 		Path("/ws/test/data_1").
 		UseTLS(false).
-		Build()
+		ChannelSize(30).
+		Build(ctx)
 	if err != nil {
 		log.Fatal(err)
 	}
+
+	go func() {
+		for range wsClient.ReconnectChannel() {
+			fmt.Println("Reconnection Success")
+		}
+	}()
+
 	dataChannel := wsClient.DataChannel()
 
 	for data := range dataChannel {
+		// _ = data
 		fmt.Println(string(data))
 	}
 }

v1/server/server.go

@@ -18,9 +18,6 @@ type SafeWebsocketServerBuilder struct {
 }
 
 func NewSafeWebsocketServerBuilder() *SafeWebsocketServerBuilder {
-	h := internal.NewHub()
-	h.Run()
-
 	return &SafeWebsocketServerBuilder{
 		upgrader: &websocket.Upgrader{
 			ReadBufferSize:  1024,