socketcluster / client-drivers

List of SocketCluster clients

SocketCluster

Toolset and boilerplate for quickly creating systems using SocketCluster. See the client and server repos for documentation:

• https://github.com/SocketCluster/socketcluster-client
• https://github.com/SocketCluster/socketcluster-server

Documentation for SCC (horizontally scalable cluster) is available at https://github.com/SocketCluster/socketcluster/blob/master/scc-guide.md

Installation

Setup the socketcluster command:

npm install -g socketcluster

or:

sudo npm install -g socketcluster

then:

socketcluster create myapp

Once it's installed, go to your new myapp/ directory and launch with:

node server

Access at URL http://localhost:8000/

Node.js v10.0.0 or above is recommended but you can also use SocketCluster with older Node.js versions if you use while loops instead of for-await-of loops.

Compatibility mode

For compatibility with existing SocketCluster clients, set the protocolVersion to 1 and make sure that the path matches your old client path:

let agServer = socketClusterServer.attach(httpServer, {
  protocolVersion: 1,
  path: '/socketcluster/'
});

Change log

See the 'releases' section for changes: https://github.com/SocketCluster/socketcluster/releases

License

(The MIT License)

Copyright (c) 2013-2023 SocketCluster.io

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

client-drivers's Issues

WeChat Client

Since weChat mini program is using a different API from browser or node.js websocket API, I want to make a socket cluster client for wechat, is that ok?

Dart client

Any plans on a Dart port?

getSocketById ?

Currently, I maintain an array of client sockets on the server side. Reason is based on certain events, i will have to lookup the correct client socket and emit events. I am sure socketcluster itself maintain a list of sockets internally and I should be able to get the socket by passing the id (something like getSocketById). However the Docs doesn't mention anything related to it ?

state of c and c++ clients

Both official c and c++ client libraries are in bad state. Both have not been updated for months. c library has no Makefile or instructions to build it. I have been trying to build c++ with various configurations of boost and beast but no luck. Just reporting on the current state in case someone is looking for them.

Go client

Hey there. It would be really great if you implemented a Go client library :)

Alternative Go Client

Howdy,

I wanted to integrate @Coinigy ( https://www.coinigy.com ), and therefore would also need SocketCluster support in Go. I initially started off with the provided Golang client, but its API appears to be a literal clone of the JS client. Now I understand this can be up to a certain extent desirable, but at the end of the day Go != Javascript.

As such, I decided to write my own implementation, which can be found here: https://github.com/Freeaqingme/go-socketcluster-client

Because Coinigy does not use JWT I did not implement that, but the other features have been implemented.

Perhaps this is worth considering to add as a second Go implementation?