https://github.com/revolunet/jsocket

jsocket server and client stuff
https://github.com/revolunet/jsocket

Last synced: about 2 months ago
JSON representation

jsocket server and client stuff

• Host: GitHub
• URL: https://github.com/revolunet/jsocket
• Owner: revolunet
• Created: 2010-02-08T17:56:57.000Z (almost 15 years ago)
• Default Branch: master
• Last Pushed: 2012-04-15T20:59:07.000Z (over 12 years ago)
• Last Synced: 2024-10-11T00:29:50.102Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 2.44 MB
• Stars: 4
• Watchers: 6
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
jSocket API

=======

jSocket is a Python/Twisted server with a javascript client API.

The goal is to bring real-time communications into any webapp thanks to a transparent javascript API.

The Javascript API is responsible of selecting the best transport available and switch to any fallback if needed. 

For some reasons, the API is similar to IRC but it *should* be much simpler.

 - A `room` is created with an initial password

 - Users can join the room with that password

 - A `master` user can join the room with a special admin password and have more control

 - A standard user can only send `messages` to the `master`user. 

 - `Master` user broadcasts messages to any client

 - Standard users are not allowed to communicate together in a single room. (This behaviour should be configurable 'per channel')

See working examples in `client/examples`

Features

---

 - Multiple transports:

     - Websocket protocols hiby-07 and hiby-10

     - FlashSocket failover

     - Http polling failover

 - Automatic browser features discovery

 - Users isolation per channel

 - Admin brodcast message to all users

 - Presence detection

 - Watchdog to kill empty rooms, inactive users...

Usage

---

 - server :

     - edit `server/config/settings.py`

     - run with `python main.py`

 - client :

     - add jsocket.js to your webpage

     - declare jsocket configuration

     - connect to the service

Todo

---

 - Server and client API redesign & docs: things should be **much much simpler**

 - think about encryption/security

 - implement JSONP+CORS for the cross-domain http failover (we need a local proxy for this actually)

 - BUG MacOSX + restart srv. the Ctrl+C never closes the http+tcp servers.

Requirements:

--

- Twisted 10.0.0+

- Python 2.5+

Brought to you by revolunet team !