Skip to content

Commit 4c6debd

Browse files
committed
Move to AHC2
1 parent d24ca38 commit 4c6debd

File tree

1 file changed

+7
-47
lines changed

1 file changed

+7
-47
lines changed

README.md

Lines changed: 7 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
Async Http Client ([@AsyncHttpClient](https://twitter.com/AsyncHttpClient) on twitter) [![Build Status](https://travis-ci.org/AsyncHttpClient/async-http-client.svg?branch=master)](https://travis-ci.org/AsyncHttpClient/async-http-client)
22
---------------------------------------------------
33

4-
[Javadoc](http://www.javadoc.io/doc/com.ning/async-http-client/)
4+
[Javadoc](http://www.javadoc.io/doc/org.asynchttpclient/async-http-client/)
55

66
[Getting](https://jfarcand.wordpress.com/2010/12/21/going-asynchronous-using-asynchttpclient-the-basic/) [started](https://jfarcand.wordpress.com/2011/01/04/going-asynchronous-using-asynchttpclient-the-complex/), and use [WebSockets](http://jfarcand.wordpress.com/2011/12/21/writing-websocket-clients-using-asynchttpclient/)
77

8-
Async Http Client library purpose is to allow Java applications to easily execute HTTP requests and asynchronously process the HTTP responses.
8+
The Async Http Client library's purpose is to allow Java applications to easily execute HTTP requests and asynchronously process the HTTP responses.
99
The library also supports the WebSocket Protocol. The Async HTTP Client library is simple to use.
1010

11+
I's built on top of [Netty](https://github.com/netty/netty) and currently requires JDK8.
12+
1113
Latest `version`: [![Maven][mavenImg]][mavenLink]
1214

1315
[mavenImg]: https://img.shields.io/maven-central/v/com.ning/async-http-client.svg
@@ -21,46 +23,14 @@ First, in order to add it to your Maven project, simply add this dependency -- s
2123
<dependency>
2224
<groupId>org.asynchttpclient</groupId>
2325
<artifactId>async-http-client</artifactId>
24-
<version>2.0.0-RC12</version>
26+
<version>LATEST_VERSION</version>
2527
</dependency>
2628
```
2729

2830
You can also download the artifact
2931

3032
[Maven Search](http://mvnrepository.com/artifact/org.asynchttpclient/async-http-client)
3133

32-
AHC is an abstraction layer that can work on top of the bare JDK, Netty and Grizzly.
33-
Note that the JDK implementation is very limited and you should **REALLY** use the other *real* providers.
34-
35-
You then have to add the Netty or Grizzly jars in the classpath.
36-
37-
For Netty:
38-
39-
```xml
40-
<dependency>
41-
<groupId>io.netty</groupId>
42-
<artifactId>netty</artifactId>
43-
<version>LATEST_NETTY_3_VERSION</version>
44-
</dependency>
45-
```
46-
47-
For Grizzly:
48-
49-
```xml
50-
<dependency>
51-
<groupId>org.glassfish.grizzly</groupId>
52-
<artifactId>connection-pool</artifactId>
53-
<version>LATEST_GRIZZLY_VERSION</version>
54-
</dependency>
55-
<dependency>
56-
<groupId>org.glassfish.grizzly</groupId>
57-
<artifactId>grizzly-websockets</artifactId>
58-
<version>LATEST_GRIZZLY_VERSION</version>
59-
</dependency>
60-
```
61-
62-
Check [migration guide](MIGRATION.md) for migrating from 1.8 to 1.9.
63-
6434
## Usage
6535

6636
Then in your code you can simply do
@@ -217,13 +187,6 @@ WebSocket websocket = c.prepareGet(getTargetUrl())
217187
}).build()).get();
218188
```
219189

220-
The library uses Java non blocking I/O for supporting asynchronous operations. The default asynchronous provider is build on top of [Netty](http://www.jboss.org/netty), but the library exposes a configurable provider SPI which allows to easily plug in other frameworks like [Grizzly](http://grizzly.java.net)
221-
222-
```java
223-
AsyncHttpClientConfig config = new AsyncHttpClientConfig.Builder().build();
224-
AsyncHttpClient client = new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config);
225-
```
226-
227190
## User Group
228191

229192
Keep up to date on the library development by joining the Asynchronous HTTP Client discussion group
@@ -238,11 +201,8 @@ Here a the few rules we'd like you to respect if you do so:
238201

239202
* Only edit the code related to the suggested change, so DON'T automatically format the classes you've edited.
240203
* Respect the formatting rules:
241-
* Ident with 4 spaces
242-
* Use a 140 chars line max length
243-
* Don't use * imports
244-
* Stick to the org, com, javax, java imports order
204+
* Indent with 4 spaces
245205
* Your PR can contain multiple commits when submitting, but once it's been reviewed, we'll ask you to squash them into a single one
246206
* Regarding licensing:
247207
* You must be the original author of the code you suggest.
248-
* If not, you have to prove that the original code was published under Apache License 2 and properly mention original copyrights.
208+
* You must give the copyright to "the AsyncHttpClient Project"

0 commit comments

Comments
 (0)