atmosphere-javascript
JavaScript

README.md

Welcome to Atmosphere: The Asynchronous WebSocket/Comet Framework

The Atmosphere Framework contains client and server side components for building Asynchronous Web Applications. The majority of popular frameworks are either supporting Atmosphere or supported natively by the framework. The Atmosphere Framework supports all major Browsers and Servers

Follow us on Twitter or get the latest news here

Atmosphere transparently supports WebSockets, Server Sent Events (SSE), Long-Polling, HTTP Streaming (Forever frame) and JSONP.

Note: In version 2.2.x, there are two versions of the scripts a jquery plugin version jquery.atmosphere.js and a plain javascript version atmosphere.js. As keeping both versions requires overhead and also confuses the users which to choose, in 2.3.x, only the plain javascript version will be supported. If you are currently using the 2.2.x jquery version, please consider migrating to the plain javascript version.

Install

manually

You can get atmosphere.js in several ways. If you use a script tag whose src attribute is set to the below one, browser may not load it because the content type served by raw.github.com is text/plain.

Also it is available from the following places, but there may be delays between a release and its availability. We don't manage these ways officially but they are managed by open source community so you can contribute.

maven

<dependency>
    <groupId>org.atmosphere.client</groupId>
    <artifactId>javascript</artifactId>
    <version>2.3.2</version>
</dependency>

npm

npm install atmosphere.js

bower

bower install atmosphere

Docs

Full API documentation can be read here and a lot of samples here

  • 2.3.0+ => Tested with Atmosphere Runtime 2.2.7+, 2.3.x, 2.4.x , may have some regression with lower version
  • 2.2.12+ => Tested with Atmosphere Runtime 2.2.7+, 2.3.x, 2.4.x , may have some regression with lower version
  • 2.2.1+ => Tested with Atmosphere Runtime 2.2.x , may work with lower version
  • 2.1.x => Tested with Atmosphere Runtime 2.1.x , may work with lower version
  • 2.0.x => Tested with Atmosphere Runtime 2.0.x and 1.0.13+

It is recommended to always use the version that matches Atmosphere's runtime.

Latest version may work with lower version, but not officially tested.

Changelogs

[Analytics]