Ecosyste.ms: Awesome

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

https://github.com/Atmosphere/atmosphere

Event Driven WebSockets Framework with Cross-Browser Fallbacks
https://github.com/Atmosphere/atmosphere

asynchronous event-driven java javascript microservices netty spring-boot websocket websockets

Last synced: about 1 month ago
JSON representation

Event Driven WebSockets Framework with Cross-Browser Fallbacks

Lists

README 

        
### 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 and JSONP.



The Atmosphere Framework works on all Servlet based servers, [Spring Boot](https://spring.io/projects/spring-boot) and frameworks like [Netty](http://atmosphere.github.io/nettosphere/), [Play! Framework](http://atmosphere.github.io/atmosphere-play/) and [Vert.x](https://github.com/Atmosphere/atmosphere-vertx). We support a variety of [extensions](https://github.com/Atmosphere/atmosphere-extensions/tree/extensions-2.4.x) like [Apache Kafka](https://github.com/Atmosphere/atmosphere-extensions/tree/master/kafka/modules), [Hazelcast](https://github.com/Atmosphere/atmosphere-extensions/tree/master/hazelcast/modules), [RabbitMQ](https://github.com/Atmosphere/atmosphere-extensions/tree/master/rabbitmq/modules), [Redis](https://github.com/Atmosphere/atmosphere-extensions/tree/master/redis/modules) and many more.



Atmosphere's Java/Scala/Android Client is called [wAsync](https://github.com/Atmosphere/wasync).



Main development branch is [atmosphere-2.7.x](https://github.com/Atmosphere/atmosphere/tree/atmosphere-2.7.x). Jakarta support is supported on branch `main`



Atmosphere 2.7.x on JDK 8 up to 21



[![Atmopshere 2.7.x](https://github.com/Atmosphere/atmosphere/actions/workflows/maven.yml/badge.svg?branch=atmosphere-2.7.x)](https://github.com/Atmosphere/atmosphere/actions/workflows/maven.yml)



Atmosphere 3.0.x on JDK 18 and 21



[![Atmopshere 3.0.x](https://github.com/Atmosphere/atmosphere/actions/workflows/maven.yml/badge.svg?branch=main)](https://github.com/Atmosphere/atmosphere/actions/workflows/maven.yml)



### Commercial support

Commercial Support is available via [Async-IO.org](http://async-io.org) 



### To use Atmosphere, add the following dependency:

```xml

     

         org.atmosphere

         atmosphere-{atmosphere-module}

         2.7.14 

      

```

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

```xml

     

         org.atmosphere

         atmosphere-runtime

         3.0.8 

      

```

     

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](http://search.maven.org/#search|ga|1|atmosphere).



### Getting started

Here's how to get your first Atmosphere project off the ground.



#### Prerequisites

Ensure you have Java 8 (or later) installed on your system. For managing your Java Project and its dependencies, you'll need a build automation tool. We recommend [Maven](https://maven.apache.org/), which is widely used in the Java ecosystem.



#### Project Setup

Create a new project using Maven. Add Atmosphere as a dependency in your `pom.xml` to access all the necessary libraries.



#### Server Configuration

In your project, you'll define a server endpoint that listens to incoming connections. Atmosphere's annotations and resource handlers make this process straightforward.



#### Running Your Server



With the server set up, use your IDE or the Maven CLI to compile and run your application.



#### Create a Client

Your web client will need to establish a connection to your server. You can create a simple HTML page with JavaScript to connect and communicate with your server endpoint.



#### Keep Going!

Once you've got the basics down, explore the full range of Atmosphere's capabilities to create more sophisticated real-time applications.



For detailed instructions, examples, and advanced configurations, refer to the [official Atmosphere tutorial](https://www.async-io.org/tutorial.html).



### Official Documentation

Complete repository of samples [sample](https://github.com/Atmosphere/atmosphere-samples/). 



Our Wiki contains [several tutorials](https://github.com/Atmosphere/atmosphere/wiki) for getting started as well as [FAQ](https://github.com/Atmosphere/atmosphere/wiki/Frequently-Asked-Questions). You can also browse the framework's [Javadoc](http://atmosphere.github.io/atmosphere/apidocs/) for Server Components, and [atmosphere.js](https://github.com/Atmosphere/atmosphere/wiki/atmosphere.js-API) for Client Components.

                                                                                         Z

#### Supported Atmosphere Versions



Atmosphere 2.7.x requires JDK 8 or 11. Atmosphere 3.0.x requires JDK 11.



@Copyright 2008-2024 [Async-IO.org](http://async-io.org)