Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/foo123/rt

RT.js: unified client-side real-time communication for JavaScript using XHR polling / BOSH / WebSockets / WebRTC
https://github.com/foo123/rt

bosh polling real-time websocket

Last synced: 3 months ago
JSON representation

RT.js: unified client-side real-time communication for JavaScript using XHR polling / BOSH / WebSockets / WebRTC

Awesome Lists containing this project

README 

          
# RT



![RT](/rt.jpg)



Unified Node/XPCOM/JS client-side real-time communication with underlying implementations for:



* [(XHR)](https://en.wikipedia.org/wiki/XMLHttpRequest) [Polling](https://en.wikipedia.org/wiki/Polling_%28computer_science%29)

* [BOSH](https://en.wikipedia.org/wiki/BOSH)

* [WebSocket](https://en.wikipedia.org/wiki/WebSocket) (native/flash/Node/XPCOM support)

* [WebRTC](https://en.wikipedia.org/wiki/WebRTC) (TODO)



**see also:**



* [ModelView](https://github.com/foo123/modelview.js) a simple, fast, powerful and flexible MVVM framework for JavaScript

* [Contemplate](https://github.com/foo123/Contemplate) a fast and versatile isomorphic template engine for PHP, JavaScript, Python

* [HtmlWidget](https://github.com/foo123/HtmlWidget) html widgets, made as simple as possible, both client and server, both desktop and mobile, can be used as (template) plugins and/or standalone for PHP, JavaScript, Python (can be used as [plugins for Contemplate](https://github.com/foo123/Contemplate/blob/master/src/js/plugins/plugins.txt))

* [Paginator](https://github.com/foo123/Paginator)  simple and flexible pagination controls generator for PHP, JavaScript, Python

* [ColorPicker](https://github.com/foo123/ColorPicker) a fully-featured and versatile color picker widget

* [Pikadaytime](https://github.com/foo123/Pikadaytime) a refreshing JavaScript Datetimepicker that is ightweight, with no dependencies

* [Timer](https://github.com/foo123/Timer) count down/count up JavaScript widget

* [InfoPopup](https://github.com/foo123/InfoPopup) a simple JavaScript class to show info popups easily for various items and events (Desktop and Mobile)

* [Popr2](https://github.com/foo123/Popr2) a small and simple popup menu library

* [area-select.js](https://github.com/foo123/area-select.js) a simple JavaScript class to select rectangular regions in DOM elements (image, canvas, video, etc..)

* [area-sortable.js](https://github.com/foo123/area-sortable.js) simple and light-weight JavaScript class for handling smooth drag-and-drop sortable items of an area (Desktop and Mobile)

* [css-color](https://github.com/foo123/css-color) simple class for manipulating color values and color formats for css, svg, canvas/image

* [jquery-plugins](https://github.com/foo123/jquery-plugins) a collection of custom jQuery plugins

* [jquery-ui-widgets](https://github.com/foo123/jquery-ui-widgets) a collection of custom, simple, useful jQueryUI Widgets

* [touchTouch](https://github.com/foo123/touchTouch) a variation of touchTouch jQuery Optimized Mobile Gallery in pure vanilla JavaScript

* [Imagik](https://github.com/foo123/Imagik) fully-featured, fully-customisable and extendable Responsive CSS3 Slideshow

* [Carousel3](https://github.com/foo123/Carousel3) HTML5 Photo Carousel using Three.js

* [Rubik3](https://github.com/foo123/Rubik3) intuitive 3D Rubik Cube with Three.js

* [MOD3](https://github.com/foo123/MOD3) JavaScript port of AS3DMod ActionScript 3D Modifier Library

* [RT](https://github.com/foo123/RT) unified client-side real-time communication for JavaScript using XHR polling / BOSH / WebSockets / WebRTC

* [AjaxListener.js](https://github.com/foo123/AjaxListener.js): Listen to any AJAX event on page with JavaScript, even by other scripts

* [asynchronous.js](https://github.com/foo123/asynchronous.js) simple manager for asynchronous, linear, parallel, sequential and interleaved tasks for JavaScript

* [classy.js](https://github.com/foo123/classy.js) Object-Oriented mini-framework for JavaScript



**Note1** `RT` is not only a simple framework around real-time layer implementations, it is also a small protocol additional to an implementation, which enables optimum performance, e.g by multiplexing multiple requests transparently (where applicable).



**Note2** some BOSH implementations (especialy javascript implementations) are actually **XMPP-BOSH** implementations (meaning they implement XMPP **over** BOSH, i.e using BOSH technique and protocol for XMPP). This is **just** the BOSH, **without the XMPP part** (which of course can be implemented **using** the BOSH method of `RT` or other method e.g websocket, but still it is an **autonomous technique in itself**)



* `RT` is also a `XPCOM JavaScript Component` (Firefox) (e.g to be used in firefox browser addons/plugins)



**Example API**



![RT Simple Chat](/rt_chat.png)



```javascript

// from real-time chat example



//e.g in node

/*

var RT = require('./RT.js');

require('./RT.Poll.js');

require('./RT.BOSH.js');

require('./RT.WebSocket.js');

*/

// in browser

/*



*/



var rt_impl = 'ws' /* 'ws'=WebSocket, 'bosh'=BOSH, 'poll'=POll */;



var rt_chat = RT({

        use: rt_impl,

        endpoint: 'ws' === rt_impl ? 'ws://127.0.0.1:1111' : ('bosh' === rt_impl ? './relay.php?bosh=1' : './relay.php?poll=1')

    })

    .on('receive', function( evt ){

        if ( !evt.data ) return;

        var m = RT.Util.Json.decode( evt.data );

        output.innerHTML += '
\

        ' + userify( m.user ) + '\

        ' + textify( m.message ) + '\

        
';

    })

    /*.one('open', function( ){

        alert('OPENED');

    })*/

    .on('close', function( ){

        alert('CLOSED!');

    })

    .on('error', function( evt ){

        alert('ERROR: '+evt.data);

    })

    .init( )

;



function send( event )

{

    if ( RT.Client.OPENED !== rt_chat.status ) return;

    if ( event && (!key_is(event, 13) || event.shiftKey) ) return;

    var msg = RT.Util.String.trim( input.value||'' );

    input.value = '';

    if ( !msg.length ) return;

    rt_chat.send(RT.Util.Json.encode({

        'user': user,

        'message': msg

    }));

}

```



[Etymology of *"real"*](https://en.wiktionary.org/wiki/real)

 compare to [names/symbols of the sun](http://www.behindthename.com/names/meaning/sun) (e.g [Ra](https://en.wikipedia.org/wiki/Ra), [Surya](https://en.wikipedia.org/wiki/Surya), [Sol](https://en.wikipedia.org/wiki/Sol_%28mythology%29), [Helios](https://en.wikipedia.org/wiki/Helios))

 compare to [rajah](https://en.wiktionary.org/wiki/rajah#English), [pharaoh](https://en.wiktionary.org/wiki/pharaoh), [regal](https://en.wiktionary.org/wiki/regal), [royal](https://en.wiktionary.org/wiki/royal), [rex](https://en.wiktionary.org/wiki/rex#Latin), [tyrannus](https://en.wiktionary.org/wiki/%CF%84%CF%8D%CF%81%CE%B1%CE%BD%CE%BD%CE%BF%CF%82#Ancient_Greek) (e.g *"Oedipus Tyrannus"*, i.e *"Oedipus Rex"*)



[Etymology of *"hour"* (as in *"time"*, *"ώρα"*)](https://en.wiktionary.org/wiki/hour) compare to [Horus](https://en.wikipedia.org/wiki/Horus), [Helios](https://en.wikipedia.org/wiki/Helios)

compare to [*"ωραίο"*, oraío, (original: "timely","in time", metaphor for "beatiful")](https://en.wiktionary.org/wiki/%CF%89%CF%81%CE%B1%CE%AF%CE%BF%CF%82#Greek)



Really beatiful, isnt it? :))