help-lixin/atmosphere

Event Driven WebSockets Framework with Cross-Browser Fallbacks

Welcome to Atmosphere: The Event Driven Framework supporting WebSocket and HTTP

The Atmosphere Framework contains client and server side components for building Asynchronous Web Applications. Atmosphere transparently supports WebSockets, Server Sent Events (SSE), Long-Polling, HTTP Streaming (Forever frame) and JSONP.

The Atmosphere Framework can be used with

The Atmosphere Framework works on all Servlet based servers, Spring Boot and frameworks like Netty, Play! Framework and Vert.x. We support a variety of extensions like Apache Kafka, Hazelcast, RabbitMQ, Redis and many more.

Atmosphere's Java/Scala/Android Client is called wAsync.

Main development branch is atmosphere-2.7.x Only pull request for that branch will be accepted.

Commercial support

Commercial Support is available via Async-IO.org

To use Atmosphere, add the following dependency:

     <dependency>
         <groupId>org.atmosphere</groupId>
         <artifactId>atmosphere-{atmosphere-module}</artifactId>
         <version>2.7.9</version> // MUST BE USED with atmosphere-javascript 3.1+
      </dependency>

Support for Jakarta EE (jakarta.*) is available with Atmosphere 3.0.0

     <dependency>
         <groupId>org.atmosphere</groupId>
         <artifactId>atmosphere-runtime</artifactId>
         <version>3.0.2</version> 
      </dependency>

atmosphere-module can be: runtime (main module), jersey, spring, kafka, guice, redis, hazelcast, jms, rabbitmq, jgroups etc. Our official releases are available from Maven Central download.

Tutorial

Get started using this step by step tutorial.

Official Documentation

Easiest way to learn Atmosphere is by trying a sample.

Our Wiki contains several tutorials for getting started as well as FAQ. You can also browse the framework's Javadoc for Server Components, and atmosphere.js for Client Components.

Quick Start

The Atmosphere Framework ships with many examples describing how to implement WebSockets, Server-Sent Events, Long-Polling, HTTP Streaming and JSONP client applications. Take a look at this page to pick the best sample to start with.

Jump directly inside the code: WebSockets, Server-Sent Events (SSE), Long-Polling, JSONP and HTTP Streaming!

Take a look at the PubSub Client-Server or the infamous Chat Client-Server to realize how simple Atmosphere is! Z

Atmosphere and JDK Versions

Atmosphere 2.5.x requires JDK 8 or 11. Atmosphere 2.4.x requires JDK 1.7 or newer

Versions

3.0.x releases: 3.0.1 [3.0.0](Jakarta Support)

2.7.x releases: 2.7.9 2.7.8 2.7.7 2.7.6 2.7.5 2.7.4 2.7.3 2.7.1 2.7.0

End Of Life Versions (go to http://async-io.org for commercial support)

2.6.x releases: 2.6.4 2.6.1 2.6.0

2.5.x releases: 2.5.14 2.5.9 2.5.5 2.5.3 2.5.2 2.5.0

2.4.x releases: 2.4.32 2.4.302.4.29 2.4.27 2.4.26 2.4.24 2.4.23 2.4.22 2.4.19 2.4.18 2.4.17 2.4.16 2.4.13 2.4.12 2.4.11 2.4.9 2.4.8 2.4.7 2.4.6 2.4.5 2.4.4 2.4.3 2.4.2 2.4.1 2.4.0

@Copyright 2008-2023 Async-IO.org