web_socket_client
web_socket_client copied to clipboard
feat: add message queue to `WebSocket` class
WebSocket Client - Message Queue Feature
This pull request adds a message queue feature to the WebSocket class to handle message queuing and ensure messages are sent in the correct order when the WebSocket connection is not yet established. The message queue stores messages that need to be transmitted to the server over the WebSocket connection until the connection is ready.
Changes Made
- Added a new private list
_messageQueueto store enqueued messages. - Modified the
sendmethod to enqueue messages when the WebSocket is not connected and send them immediately when the WebSocket is connected. - Created a new private method
_sendQueuedMessagesto process and send messages from the queue when the WebSocket is connected. - Modified the
_connectmethod to call_sendQueuedMessagesafter establishing the WebSocket connection to send any enqueued messages.
Reasoning
The addition of the message queue ensures that messages are sent in the order they were queued once the WebSocket connection is established. This improves the reliability and consistency of the WebSocket client, preventing potential issues with message order and avoiding unresponsive behavior when sending messages before the connection is ready.
Type of Change
- [x] โจ New feature (non-breaking change which adds functionality)
- [ ] ๐ ๏ธ Bug fix (non-breaking change which fixes an issue)
- [ ] โ Breaking change (fix or feature that would cause existing functionality to change)
- [ ] ๐งน Code refactor
- [ ] โ Build configuration change
- [ ] ๐ Documentation
- [ ] ๐๏ธ Chore