Description
The websocket_helper
and websocket
modules are both needed to establish and use a websocket connection. Each handles a different part of a websocket connection's lifecycle. The former handles the the initial handshake needed to establish the connection, and the latter handles the on-going use of the connection. While this technically works acceptably, it creates confusion and makes the use of websockets unnecessarily complex for users. To effectively use these modules, a user first has to find both modules and determine that they are intended to be used together. This almost certainly requires an awareness of websocket plumbing. In lieu of this, the user likely needs to be able to review the code for both modules to gain this knowledge. This makes the use of websockets unrealistic for less sophisticated users. Arguably this situation can be improved through documentation alone. However, unifying the interfaces and making their use more intuitive would be better, and even simplify any subsequent documentation effort.