https://github.com/sean-codes/cs-sockets

NodeJS server for CS Engine
https://github.com/sean-codes/cs-sockets

Last synced: about 1 year ago
JSON representation

NodeJS server for CS Engine

• Host: GitHub
• URL: https://github.com/sean-codes/cs-sockets
• Owner: sean-codes
• Created: 2016-12-15T11:08:03.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-07-27T19:32:43.000Z (almost 9 years ago)
• Last Synced: 2025-03-27T13:01:44.513Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 86.9 KB
• Stars: 8
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# CS-Sockets

Pure NodeJS server for snappy string networking

>npm install cs-sockets

# Purpose 

Text only based networking for simple JSON networking

# Performance

Local Machine ~3,000 per second 256 byte string Up/Down

100k 127byte strings Up/Down in 1 minute.

Remote ~500+ 256 byte string Up/Down (Coffee Shop Wireless Connection)

# Usage

### An echo server:

    const csServer = require('csServer');

    const server = new csServer({ port: '9999' });

    server.on('connect', function(socket){

        

    server.on('message', function(socket, message){

            this.send(socket, message);

        });

    });

### Starting CS-Sockets:

    const csServer = require('csServer');

    const server = new csServer({[options]})

### Socket Opens Connection:

    csServer.on('connect', [function(socket)]);

### Socket Sends Data:

    csServer.on('message', [function(message)]);

### Sending Data to a socket:

    csServer.send([socket to receive], message);

### Socket Disconnecting

    csServer.on('disconnect', [function(socket)])

### SSL Connections

To use your SSL and Key add a ssl field to your csServer options

>When the server starts you should see the message Starting Server (SSL)

    const server = new csServer({

        port: 9999,

        ssl: {

            key: '/etc/letsencrypt/archive/cube-script.net/privkey1.pem',//Your key path

            cert: '/etc/letsencrypt/archive/cube-script.net/fullchain1.pem'//Your Cert Path

        }

    });