Echtzeit is a highly optimized toolset for pub/sub messaging between web clients built to scale.
This is an enterprise fork of Faye, please see http://faye.jcoglan.com for further information on the general purpose toolset with Ruby/Rack support. However, we endorse any business to business dialog and are open for support at kenan@legify.com — please include information about the company you represent and the purpose of your echtzeit integration.
npm install echtzeit
With the recent changes echtzeit and Faye, the engine will only listen if it is attached to an arbitrary server. Where echtzeit.listen was used, create a new server [var srv = (http/https).createServer()], attach an initialized instance [var ez = new echtzeit.NodeAdapter({mount: '/', timeout: 45})] to the server with [ez.attach(srv)] and finally listen to a port by [srv.listen(…)].
Echtzeit makes it easy to kickstart your realtime environment by providing an abstraction layer which covers all transport-ways you love including WebSocket, JSONP, Polling and XHR. Echtzeit is adaptive and implements an intelligent extension system.
You kickstart the echtzeit engine by initializing it and attaching it to an arbitrary server of your choice — including http, https and spdy.
var echtzeit = require("echtzeit"),
ez = new echtzeit.NodeAdapter({mount: '/app', timeout: 45});
The mountpoint makes it easy to attach to a server without disrupting its functions or service.
var srv = http.Server(); ez.attach(srv); srv.listen(643);
If you power it up and head to http://127.0.0.1:643/app/client.js you'll see echtzeit's client library — which also implies echtzeit is working.
This is great! Let's listen to a channel and ditch that rocket-science degree:
ez.getClient().subscribe("/public", function ( message ) { });
We're using echtzeit's internal client for the server which gets rid of all the initialization clutter we would might face. Great so far, let's get started with the userland.
This ain't rocket-science, too: just include the client library and use the same way to connect to echtzeit.
<script type="text/javascript" src="http://127.0.0.1:643/app/client.js"></script>
<script type="text/javascript">
var ez = new echtzeit.Client('http://127.0.0.1:643/app');
</script>
Now listen on a channel and you're ready to go:
ez.subscribe('/public', function( message ) { alert( message.text ) });
Go ahead, open some windows and type this into the console of one window:
ez.publish("/public", { text: "Hey, friends!" });
You can do the plain same on the server:
ez.getClient().publish('/public', { text: "Hey, friends!" });
Feel free to open an issue if you think anything specific to this fork should be discussed. PRs are welcome. See the above notice if you have questions regarding echtzeit.
Copyright (c) 2013 by Legify UG. All Rights Reserved.
[Portions/Faye] Copyright (c) 2009-2013 James Coglan and contributors
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.